如何在WebApi中使用Swagger

最近和别的部门合作,需要对方提供接口,对方程序员发来一个叫swagger的网页,感觉很牛逼,效率什么的远远超过我之前手写API文档,于是遵循“比我优秀的都值得学习”的思想,我上网总结了一下swagger的用法,也算是做一个记录。

配置环境:

  编译器:VS2017

  系统:windows7

配置步骤:

  1.首先打开vs Negut管理包控制台

如何在WebApi中使用Swagger

然后输入   Install-Package Swashbuckle

2.安装完成之后,右击自己的项目,属性-》生成-》输出-》勾选 XML文档文件-》复制该输入框的内容

3.打开该文件(让swagger显示注释)

如何在WebApi中使用Swagger

在swagger文件夹配置后面加上这句

c.IncludeXmlComments(Path.Combine(System.AppDomain.CurrentDomain.BaseDirectory, @"这里粘贴你刚才复制的路径"));

4.运行程序,复制你的链接,在后面加上 “/swagger”,就可以使用和测试swagger生成的API文档了