asp.net core使用Swashbuckle.AspNetCore(swagger)生成接口文档

asp.net core中使用Swashbuckle.AspNetCore生成接口文档

Swashbuckle.AspNetCore:swagger的asp.net core实现，本文使用版本为v1.1.0
项目地址：https://github.com/domaindrivendev/Swashbuckle.AspNetCore
仔细看了下readme,发现在百度找半天的东西其实readme里面就有...

开局一张图，然后开始编，一些基本的asp.net core东西就不再赘述，本文只对Swashbuckle.AspNetCore的几个使用要点进行描述。

如上图所示，包含功能如下（完整示例见文末）

1. 基础使用,添加controler的说明(IDocumentFilter)
2. 汉化操作按钮
3. 添加通用参数(header)-实现IOperationFilter
4. 多版本控制(暂时见demo)
5. 使用JWT的简单接口验证(暂时见demo)

构建一个webapi项目并使用swagger

1. 新建asp.net core webapi项目 dotnet new webapi
2. 安装nuget包：Swashbuckle.AspNetCore,本文使用版本1.1.0,.net core版本2.0+
3. 编辑解决方案添加(或者在vs中项目属性->生成->勾选生成xml文档文件)如下配置片段

      <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
        <DocumentationFile>bin\Debug\netcoreapp2.0\项目名称.xml</DocumentationFile> </PropertyGroup>

1. 使用Swagger并注入汉化脚本

c.SwaggerDoc配置接口描述信息
c.OperationFilter可通过IOperationFilter接口去添加一些公共的参数
c.DocumentFilter通过IDocumentFilter接口去生成控制器的标签(描述)
注：ConfigureServices的方法返回值修改了，为了能够正常的使用ServiceLocator获取服务

private const string _Project_Name = "AspNetCoreSwaggerDemo";