ASP.NET Web API 使用Swagger 自动生成api文档

撸项目的时候,每次接口写完,基本上写文档就成了最纠结的事情,虽然没什么难度。但是工作量还是挺费劲的。之前有了解过Swagger但是没有用过,正好这次研究下,与大家分享下。

1、先到NuGet安装Swagger

ASP.NET Web API 使用Swagger 自动生成api文档

2、找到SwaggerConfig.cs。下面划红线的就是版本与名称

ASP.NET Web API 使用Swagger 自动生成api文档

3、创建项目XML文档

ASP.NET Web API 使用Swagger 自动生成api文档

4、修改SwaggerConfig.cs中的启动配置项

ASP.NET Web API 使用Swagger 自动生成api文档

c.IncludeXmlComments(string.Format("{0}/bin/QY.WebApi.xml", System.AppDomain.CurrentDomain.BaseDirectory));

5、直接运行找到路径 http://localhost:52789/swagger/   就可以看到你的文档了。