WebApi配置Swagger

碎碎念的安静

于 2020-04-27 11:58:37 发布

阅读量1.3k

点赞数

分类专栏： WebApi 文章标签： c#

本文链接：https://blog.youkuaiyun.com/qq_29242649/article/details/105787235

版权

WebApi 专栏收录该内容

3 篇文章

订阅专栏

WebApi配置Swagger流程

1.添加NuGet包

在项目的NuGet包管理器中搜索名为Swashbuckle的包，然后安装
swagger nuget包

2.配置项目属性

生成中勾选XML文档，填写文件名
项目属性配置

3.设置swagger

在App_Start文件夹下创建名为SwaggerConfig的类，添加以下内容

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

        GlobalConfiguration.Configuration
            .EnableSwagger(c =>
                {
                    //swagger配置
                    c.IncludeXmlComments(GetXmlCommentsPath());
                    c.SingleApiVersion("v1", "TestWebApi");
                })
            .EnableSwaggerUi(c =>
                {
                	c.DocumentTitle("My webapi");
                });
    }
    private static string GetXmlCommentsPath()
    {
        return String.Format(@"{0}\bin\TestWebApi.xml", System.AppDomain.CurrentDomain.BaseDirectory);
    }
}