Asp.net添加 Swagger

本文介绍如何在ASP.NET WebAPI项目中使用Swagger自动生成API文档,包括项目创建、依赖库添加及配置过程,通过实例演示了Swagger在WebAPI项目中的集成与使用。

ASP.NET 使用Swagger开发WebApi接口项目:项目使用Web API创建自动提供了API文档,采用mvc方式创建项目稍麻烦点需要手动添加WebApiConfig配置,而采用Web API项目这些都已经生成好了。

创建Web API项目

添加Swagger依赖库

Swagger生成的文件

项目右键属性>生成>添加XML生成配置:

Web API提供的API列表
打开项目启动主页:http://localhost:54790/

Web API项目集成了API列表:

SwaggerAPI提供的API列表
浏览器输入:http://localhost:54790/swagger/ui/index#/

具体接口测试:

Swagger注意事项
1、启动如果报错,请注释掉如下内容

可以在index.cshtml 里面添加如下代码直接访问

 <div>
     <br />
     <a href="../swagger"><h1>swagger接口文档及测试</h1></a>
     <br /><br />
     @*<a href="../Home/UploadTest"><h1>文件上传演示</h1></a>*@
 </div>
### ASP.NET 中配置 Swagger 的方法 在 ASP.NET 项目中正确配置 Swagger 是为了提供 API 文档和测试界面的功能。以下是关于如何实现这一目标的具体说明。 #### 1. 创建 ASP.NET Web 应用程序 首先,需要创建一个新的 ASP.XMLNET Web 应用程序并选择空模板作为项目的起点[^2]。这一步是为了确保项目结构清晰且易于管理。 #### 2. 安装必要的 NuGet 包 要使 Swagger 功能正常运行,必须安装 `Swashbuckle` 和 `Swashbuckle.Core` 这两个 NuGet 包。这些包提供了集成 Swagger 所需的核心功能和支持。 可以通过以下命令来安装它们: ```bash Install-Package Swashbuckle Install-Package Swashbuckle.Core ``` #### 3. 添加必要文件夹 在项目中添加几个关键文件夹以便更好地组织代码: - **App_Start**: 此文件夹用于放置启动项配置文件(如 `SwaggerConfig.cs`),它定义了应用程序初始化期间执行的操作。 - **Controllers**: 存放所有的控制器类,即实际的 API 接口逻辑所在位置。 - **Scripts**: 如果计划对 Swagger UI 进行自定义修改或者汉化,则可以在此处存储 JavaScript 文件。 #### 4. 配置 Swagger 设置 编辑或新增 `SwaggerConfig.cs` 文件,在其中加入如下所示的关键配置代码片段: ```csharp GlobalConfiguration.Configuration .EnableSwagger(c => { c.CustomProvider((defaultProvider) => new SwaggerCacheProvider( defaultProvider, $@"{System.AppDomain.CurrentDomain.BaseDirectory}\bin\API.Test.xml" ) ); }) .EnableSwaggerUi(c => { c.InjectJavaScript(System.Reflection.Assembly.GetExecutingAssembly(), "API.Test.swagger.js"); }); ``` 上述代码实现了两方面的功能:一是启用了 Swagger 并指定了 XML 注释文件路径;二是增强了 Swagger UI,默认注入了一个额外的 JavaScript 脚本以支持更多特性[^1]。 #### 5. 确保 XML 文档生成启用 为了让 Swagger 自动读取 API 方法上的注释信息,还需要确认项目属性中的“XML 文档文件”选项已被勾选,并指向正确的输出目录(通常为 `/bin/YourProjectName.xml`)。这样做的目的是让 Swagger 可以解析到详细的描述文字。 --- ### 总结 通过以上步骤即可完成在一个标准 ASP.NET Web Api 项目里设置好 Swagger 工具链的工作流程。此过程不仅简化了开发者对于复杂 RESTful APIs 的理解难度,同时也极大地提高了调试效率。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值