Asp.Net Core使用swagger生成api文檔的完整步驟

來源：本站原創(chuàng)|時(shí)間：2020-01-11|欄目：ASP.NET|點(diǎn)擊：次

前言

.Net Core中有兩個(gè)集成NSwag的包，分別為Swashbuckle和NSwag。兩者的配置大同小異。這里以NSwag為例。

一、前期準(zhǔn)備

1、初始化asp.net core 測(cè)試項(xiàng)目

新建asp.net core項(xiàng)目，此處略過；

新建apicontroller，并編寫測(cè)試代碼；

 [Route("api/[controller]")]
 [ApiController]
 public class UserApiController : ControllerBase
 {
 /// <summary>
 /// 獲取用戶信息，根據(jù)用戶id
 /// </summary>
 /// <param name="id">用戶id</param>
 /// <returns></returns>
 [HttpGet("getuser/{id}")]
 public ActionResult GetUser(int id)
 {
  User u = new User { Id=1,Name="Jack"};
  return Ok(new { ok = true, data = u });
 }
 /// <summary>
 /// 添加用戶
 /// </summary>
 /// <param name="user">用戶信息</param>
 /// <returns></returns>
 [HttpPost("postuser")]
 public ActionResult AddUser([FromBody]User user)
 {
  return Ok(new { ok = true, data = user });
 }
 }

 public class User
 { 
 /// <summary>
 /// 用戶id
 /// </summary>
 public int Id { get; set; }
 /// <summary>
 /// 用戶姓名
 /// </summary>
 public string Name { get; set; }
 }

2、使用nuget安裝 NSwag.AspNetCore

方式一：通過vs圖形界面安裝；

方式二：通過nuget 命令安裝：

Install-Package NSwag.AspNetCore

二、配置Swagger

1、添加并配置 Swagger 中間件

在應(yīng)用的Startup類中的ConfigureServices 方法中，注冊(cè)所需的 Swagger 服務(wù)：

  public void ConfigureServices(IServiceCollection services)
  {
   services.AddControllersWithViews();
   
   // Register the Swagger services
   services.AddSwaggerDocument()
  }

在 Startup類中的Configure 方法中，啟用中間件為生成的 Swagger 規(guī)范和 Swagger UI 提供服務(wù)：

public void Configure(IApplicationBuilder app)
{
 app.UseStaticFiles();

 // Register the Swagger generator and the Swagger UI middlewares
 app.UseOpenApi();
 app.UseSwaggerUi3();

 app.UseMvc();
}

啟動(dòng)應(yīng)用。轉(zhuǎn)到：

http://localhost:/swagger，以查看 Swagger UI。

http://localhost:/swagger/v1/swagger.json，以查看 Swagger 規(guī)范。

2、自定義 API 文檔

API 信息和說明

在 Startup.ConfigureServices 方法中，傳遞給 AddSwaggerDocument 方法的配置操作會(huì)添加諸如作者、許可證和說明的信息：

  public void ConfigureServices(IServiceCollection services)
  {
   //services.AddControllers();
   services.AddControllersWithViews();

   services.AddSwaggerDocument(config =>
   {
    config.PostProcess = document =>
    {
     document.Info.Version = "v1";
     document.Info.Title = "UserManageApp API";
     document.Info.Description = "A simple ASP.NET Core web API";
     document.Info.TermsOfService = "None";
     document.Info.Contact = new NSwag.OpenApiContact
     {
      Name = "張三",
      Email = string.Empty,
      Url = "https://example.com"
     };
     document.Info.License = new NSwag.OpenApiLicense
     {
      Name = "Use under LICX",
      Url = "https://example.com/license"
     };
    };
   });
  }

Swagger UI 顯示版本的信息：

XML 注釋

若要啟用 XML 注釋，請(qǐng)執(zhí)行以下步驟：

以windows先使用vs為例：