使用Swagger制作WebApi的接口

首页 > 代码库 > 使用Swagger制作WebApi的接口

使用Swagger制作WebApi的接口

2024-10-15 08:41:39 216人阅读

首先，创建一个空的WebApi项目

之后，创建Controller，然后继承ApiController

技术分享

之后呢，我们需要写个方法，当然，都是有返回值的，不能用return View()啥的（毕竟是返回数据用的接口）

然后，我们需要引用NuGet里头的 Swashbuckle、swagger.Net.UI

技术分享

注：引用完 Swashbuckle，会在App_Start里头生成一个 SwaggerConfig（用来配置Swagger参数的，强烈建议使用稳定版本的，我用了一下最新预发行版，结果没生成这个文件，之后再次引用下5.53的稳定版，丫丫的，也可能是这个文件需要后面才引用--在引用swagger.Net.UI之后）

配置参数：

using System.Web.Http;
using WebActivatorEx;
using wp3;
using Swashbuckle.Application;

[assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]

namespace wp3
{
    /// <summary>
    /// Swagger配置
    /// </summary>
    public class SwaggerConfig
    {
　　　　 //加了这个
        private static string GetXmlCommentsPath()
        {
            return string.Format(@"{0}\bin\wp3.XML", System.AppDomain.CurrentDomain.BaseDirectory);
        }

        public static void Register()
        {
            var thisAssembly = typeof(SwaggerConfig).Assembly;

            GlobalConfiguration.Configuration 
                .EnableSwagger(c =>
                    {
                        c.SingleApiVersion("v1", "wp3");
                        c.IncludeXmlComments(GetXmlCommentsPath());//加了这个
　　　　　　　　　　 })
                .EnableSwaggerUi(c =>
                    {                   
 　　　　　　});
        }
    }
}