Step1 添加NuGet包 Swashbuckle

  WebApi结合Swagger ui 实现在线接口文档_第1张图片

  step2 修改SwaggerConfig.cs

  Swasshbuckle 安装完成之后会在App_Start下创建一个名为SwaggerConfig.cs的类,把内容替换为:

  WebApi结合Swagger ui 实现在线接口文档_第2张图片

  Step3 创建生成XML

  右键你的项目→属性→生成→选中下方的 "XML文档文件" 然后保存

  WebApi结合Swagger ui 实现在线接口文档_第3张图片

  step4 启动你的项目

  访问地址为:http://localhost:58192/swagger/

  WebApi结合Swagger ui 实现在线接口文档_第4张图片

  扩展:在Swagger中 实现 自定义 HTTP Header

  在开发移动端 API时常常需要验证权限,验证参数放在Http请求头中是再好不过了。WebAPI配合过滤器验证权限即可

  首先我们需要创建一个 IOperationFilter 接口的类。IOperationFilter:

  WebApi结合Swagger ui 实现在线接口文档_第5张图片

  在 SwaggerConfig.cs 的 EnableSwagger 配置匿名方法类添加一行注册代码

  c.OperationFilter();

  WebApi结合Swagger ui 实现在线接口文档_第6张图片

  添加权限过滤器

  WebApi结合Swagger ui 实现在线接口文档_第7张图片

  运行 swagger

WebApi结合Swagger ui 实现在线接口文档_第8张图片