如何使用Swagger為.NET Core 3.0應用添加JWT授權說明文檔

簡介

本教程采用WHY-WHAT-HOW黃金圈思維模式編寫，黃金圈法則強調的是從WHY為什麼學，到WHAT學到什麼，再到HOW如何學。從模糊到清晰的學習模式。大家的時間都很寶貴，我們做事前先想清楚為什麼要做，學完能達到什麼樣的目标，然後我們再考慮要達到這個目的，通過什麼樣的方法來實作。

嘗試一些事，遭遇失敗後從中學習，比什麼事都不做更好。—馬克．佐克伯

為什麼要學？

對于開發人員來說，**調試API接口和生成API文檔是一件極其頭疼的事情。我們在百忙之中，還不得不為前端開發人員編寫接口文檔，來描述系統中N個接口的參數及傳回狀态，再借助PostMan等第三方工具來測試API的正确性。在Swagger誕生後，這項體力活終于得到了極大的改善，我們不但可以自動建構漂亮的互動式API說明文檔，還可以直接調試API接口的正确性。最新版的Swagger已經完美支援Open Api規範及JWT Token授權通路等。

能學到什麼？

• 使用 Swagger 生成精美的API接口文檔
• 使用 Swagger 調試JWT授權接口
• 使用 Swagger 生成各個類庫中視圖模型的描述

怎麼做？

Swagger項目開源位址：https://github.com/domaindrivendev/Swashbuckle.AspNetCore

建立一個.NET Core項目

首先，建立一個.NET Core 3.0 Web Api 項目，打開Nuget安裝管理器，勾選左下角的***顯示預覽發行包***，搜尋Swashbuckle.AspNetCore，版本選擇5.0.0-rc4的點添加，注意因為.NET Core 3.0剛出不久，目前支援的庫很多都是預覽版，這裡我選5.0.0-beta是會報錯，選5.0.0-rc4使用正常。

設定生成XML描述資訊

耐心等待幾秒鐘添加完成後，我們選中左側剛才建立的Api項目，右鍵>屬性（Mac裡叫選項），勾選***生成XML文檔***，這個是用來生成為Swagger所用的描述資訊。

開始配置Swagger

然後我們打開***Startup.cs***檔案，來對Swagger配置進行一些必要的配置，在***ConfigureServices***方法我們添加一下Swagger配置：

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo
    {
        Version = "v1",
        Title = "Crypto Exchange",
        Description = "基于.NET Core 3.0 的區塊鍊數字貨币交易所",
        Contact = new OpenApiContact 
        {
            Name = "Microfisher",
            Email = "[email protected]",
            Url = new Uri("http://cnblogs.com/microfisher"),
        },
    });

    // 加載程式集的xml描述文檔
    var baseDirectory = System.AppDomain.CurrentDomain.BaseDirectory;
    var xmlFile = System.AppDomain.CurrentDomain.FriendlyName  ".xml";
    var xmlPath = Path.Combine(baseDirectory, xmlFile);
    c.IncludeXmlComments(xmlPath);
})
           

參數都很簡單，就是Swagger界面上顯示的一些資訊，注意這裡一定要習慣使用Path.Combine來拼接路徑，很多同學喜歡雙斜杠來拼接，在Mac和Linux下是會出問題的，既然已經擁抱開源技術，盡量使用Mac或Linux來開發.NET Core吧。然後我們在***Configure***方法裡添加以下代碼：

app.UseSwagger();
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "Crypto Exchange");
    // 通路Swagger的路由字尾
    c.RoutePrefix = "swagger";
});
           

預覽一下小成果

到這裡為止，我們的Swagger的最基本的配置就完成了，其中RoutePrefix是通路Swagger的路由，如果設定為空則不需要輸入/swagger字尾來通路。現在我們F5啟動項目看看，我的本地網址是https://localhost:5000，是以直接通路：https://localhost:5000/swagger如下圖所示，我去這界面也太醜了，說好的精美絕倫呢？不急不急，我們慢慢調優：

啟用API文檔的JWT授權

目前很多網站都使用了JWT（JSON WEB TOKEN）來作為賬戶系統的認證授權，JWT以它的簡單、高效、分布式優勢很快成為了網站的流行驗證方式。這裡我們不做過多的介紹，如果大家感興趣我可以再寫一篇長文來介紹JWT的優勢和使用方法。我們繼續來為Swagger添加JWT授權認證，依舊打開***Startup.cs***檔案，修改上面***ConfigureServices***方法中的代碼：

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo
    {
        Version = "v1",
        Title = "Crypto Exchange",
        Description = "基于.NET Core 3.0 的區塊鍊數字貨币交易所",
        Contact = new OpenApiContact
        {
            Name = "Microfisher",
            Email = "[email protected]",
            Url = new Uri("http://cnblogs.com/microfisher"),
        },
    });

    c.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme()
    {
        Description = "在下框中輸入請求頭中需要添加Jwt授權Token：Bearer Token",
        Name = "Authorization",
        In = ParameterLocation.Header,
        Type = SecuritySchemeType.ApiKey,
        BearerFormat = "JWT",
        Scheme = "Bearer"
    });

    c.AddSecurityRequirement(new OpenApiSecurityRequirement
    {
        {
            new OpenApiSecurityScheme
            {
                Reference = new OpenApiReference {
                    Type = ReferenceType.SecurityScheme,
                    Id = "Bearer"
                }
            },
            new string[] { }
        }
    });

    var baseDirectory = System.AppDomain.CurrentDomain.BaseDirectory;
    var xmlFile = System.AppDomain.CurrentDomain.FriendlyName   ".xml";
    var xmlPath = Path.Combine(baseDirectory, xmlFile);
    c.IncludeXmlComments(xmlPath);
});
           

預覽一下授權設定

然後再啟動項目，你會發現右側多了一個***Authorize***綠色的帶鎖按鈕，這個按鈕點開後就可以設定我們的JWT Token資訊了，格式是：Bearer 你的Token字元串，注意Bearer于Token之間有個空格。設定好Token後，你請求任意的API接口時，Swagger會自動附帶Token到請求的Header中。

建立一個RESTFUL接口

上面我們已經實作了Swagger的各項配置，現在我們來删除預設生成的控制器***WeatherForecastController***及視圖模型***WeatherForecast***，建立一個AccountController及幾個視圖模型，讓Swagger傳回帶描述的接口文檔。

//[Authorize]
[Produces("application/json")]
[Route("v1/[controller]")]
[ApiController]
public class AccountController : ControllerBase
{
    /// <summary>
    /// 建立資訊
    /// </summary>
    /// <param name="createViewModel">參數</param>
    /// <returns>狀态</returns>
    [HttpPost]
    public StatusViewModel Post([FromBody]CreateViewModel createViewModel)
    {
        return new StatusViewModel { };
    }

    /// <summary>
    /// 删除資訊
    /// </summary>
    /// <param name="deleteViewModel">參數</param>
    /// <returns></returns>
    [HttpDelete]
    public StatusViewModel Delete([FromQuery]DeleteViewModel deleteViewModel)
    {
        return new StatusViewModel { };
    }

    /// <summary>
    /// 查詢資訊
    /// </summary>
    /// <param name="queryViewModel">參數</param>
    /// <returns></returns>
    [HttpGet]
    public StatusViewModel Get([FromQuery]QueryViewModel queryViewModel)
    {
        return new StatusViewModel { };
    }

    /// <summary>
    /// 修改資訊
    /// </summary>
    /// <param name="updateViewModel">參數</param>
    /// <returns></returns>
    [HttpPut]
    public StatusViewModel Put([FromQuery]UpdateViewModel updateViewModel)
    {
        return new StatusViewModel { };
    }
}
           

建立幾個視圖模型

再按自己喜歡的風格建立幾個視圖模型，用///為各個字段添加summary後如下：

public class UpdateViewModel
{
    /// <summary>
    /// ID
    /// </summary>
    public long Id { get; set; }

    /// <summary>
    /// 賬号
    /// </summary>
    public long Account { get; set; }

    /// <summary>
    /// 密碼
    /// </summary>
    public long Password { get; set; }
}
           

測試最終成果

最後我們來看看效果，随便展開一個API接口，可以看到我們給視圖模型寫的注釋已經顯示在Swagger上了，前端開發人員一看就懂，輸入一些接口參數，點一下執行就能看到傳回值了：

再看我們的請求Header中已經包含了JWT授權資訊（Bearer 123456789）是我随意設定的，讓你們前端調試的時候換成你們的Token就行了。

項目代碼，喜歡請加個星

https://github.com/microfisher/Tutorials