.Net WebAPI 增加Swagger

第一部分:创建项目

选择Web/ASP.NET Web Application

.Net WebAPI 增加Swagger

这里我选择的是WebAPI,并且增加MVC和Web API,权限部分选择无权限

.Net WebAPI 增加Swagger

 

 


 

第二部分:增加EF连接

因为项目需要连接至SQL Server,在Web API项目中增加EF是比较好的选择。

.Net WebAPI 增加Swagger

因为数据已经是存在的,所以选择DB first

.Net WebAPI 增加Swagger

创建新的数据库连接

.Net WebAPI 增加Swagger

选择数据源为SQL Server

.Net WebAPI 增加Swagger

输入数据库信息,并连接至数据库

.Net WebAPI 增加Swagger

选择将当前连接字符串包含至项目中

.Net WebAPI 增加Swagger

选择需要导入的数据库对象,这里我们不需要选择任何的数据库对象,因为只需要从系统中运行SQL语句获取相应的数据即可。

.Net WebAPI 增加Swagger

 

 


第三部分:增加Swagger引用

在项目解决方案中,鼠标右键,选择管理NuGet包

.Net WebAPI 增加Swagger

在包查询时输入swashbuckle,并点击进行安装

.Net WebAPI 增加Swagger

安装时,会需要选择引用的项目

.Net WebAPI 增加Swagger

安装中

.Net WebAPI 增加Swagger

安装完成后,会发现在项目文件夹App_Start会加入一个新文件SwaggerConfig.cs

.Net WebAPI 增加Swagger

找到该行,将前面的注释删除即可

.Net WebAPI 增加Swagger

并且创建新的方法

.Net WebAPI 增加Swagger

创建的方法如下

.Net WebAPI 增加Swagger

暂时不修改方法中的代码,打开项目属性

.Net WebAPI 增加Swagger

项目默认配置,点击以下XML documentation file

.Net WebAPI 增加Swagger

选择后,并使用默认的文件名,也可以修改其中的文件名,将其中的路径加文件名复制至之前的方法

.Net WebAPI 增加Swagger

将项目属性中配置的XML文档位置加入至方法中

.Net WebAPI 增加Swagger