.NET中的Swagger使用示例详解

这篇文章将为大家详细讲解有关.NET中的Swagger使用示例详解，小编觉得挺实用的，因此分享给大家做个参考，希望大家阅读完这篇文章后可以有所收获。

简介

Swagger 是一个用于描述和记录 RESTful API 的规范。它定义了一个通用的语言，允许开发人员轻松地共享和使用 API 信息。 .NET 中的 Swagger 可帮助开发人员生成交互式 API 文档，并简化 API 的开发和测试。

安装

要在 .NET 项目中使用 Swagger，请安装以下 NuGet 包：

Install-Package Swashbuckle.AspNetCore

使用

1. 为控制器启用 Swagger 文档：

   在控制器类中添加以下特性：

   [SwaggerResponse(statusCode: 200, description: "Success", type: typeof(List<Item>))]
   [SwaggerOperation(summary: "Get all items", description: "Gets all items from the database")]
   [HttpGet]
   public IActionResult GetItems()
   {
       // Your code here
   }

   此特性指定了控制器操作的 Swagger 文档信息，包括状态码、响应类型和摘要描述。

2. 为操作添加 Swagger 文档：

   使用以下特性为操作参数和返回类型添加 Swagger 文档：

   /// <summary>
   /// The ID of the item to get
   /// </summary>
   [FromRoute]
   [SwaggerParameter("id", Required = true, Type = typeof(int))]
   public int Id { get; set; }

   此特性提供了有关操作参数的详细信息，包括名称、类型和必需性。

3. 配置 Swagger 设置：

   在 Startup.cs 文件中添加以下代码以配置 Swagger 设置：

   public void ConfigureServices(IServiceCollection services)
   {
       // Add Swagger services
       services.AddSwaggerGen(c =>
       {
           c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
       });
   }
   
   public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
   {
       // Enable middleware to serve generated Swagger as a JSON endpoint
       app.UseSwagger();
   
       // Enable middleware to serve Swagger-UI (HTML, JS, CSS, etc.), specifying the Swagger JSON endpoint.
       app.UseSwaggerUI(c =>
       {
           c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
       });
   }

   这将启用 Swagger 中间件并配置 Swagger 文档的路径。

使用 Swagger UI

配置 Swagger 后，可以在浏览器中使用 Swagger UI 浏览和测试 API。导航到以下 URL：

https://[your-api-base-url]/swagger/index.html

这将显示一个交互式界面，其中包含 API 文档、端点列表和请求/响应信息。

优点

使用 .NET 中的 Swagger 提供以下优点：

• 自动生成交互式 API 文档
• 简化 API 的开发和测试
• 提高代码的可维护性
• 促进 API 的可发现性
• 促进与第三方应用程序和服务的集成

以上就是.NET中的Swagger使用示例详解的详细内容，更多请关注编程学习网其它相关文章！