.Net WebAPI 增加Swagger

本文详细介绍如何使用ASP.NET创建WebAPI项目,并整合MVC与EF实现数据库操作,同时引入Swagger提升API文档的生成效率。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

第一部分:创建项目

选择Web/ASP.NET Web Application

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

 

 


 

第二部分:增加EF连接

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

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

创建新的数据库连接

选择数据源为SQL Server

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

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

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

 

 


第三部分:增加Swagger引用

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

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

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

安装中

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

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

并且创建新的方法

创建的方法如下

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

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

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

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

 

转载于:https://www.cnblogs.com/weschen/p/7874148.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值