Magicodes.SwaggerUI

通過配置檔案簡單配置即可快速完成SwaggerUI的配置，包括：

• SwaggerUI的文件資訊
• API分組
• API隱藏
• API JSON生成（列舉、API架構Id）
• 驗證
• 自定義頁面

支援.NET Core 2.2和3.1。版本日誌和使用教程見下文。

注意：AddCustomSwaggerGen和UseCustomSwaggerUI已分別替換為“AddMagicodesSwaggerGen”、“UseMagicodesSwaggerUI”。

更新日誌

2020.03.07

• 【Nuget】Magicodes.SwaggerUI 3.0.2
• 【升級】支援.NET Core 3.1
• 【重構】支援自定義邏輯編寫：
  • AddMagicodesSwaggerGen新增Action<SwaggerGenOptions, SwaggerConfigInfo>引數，可以實現自定義邏輯
  • UseMagicodesSwaggerUI新增Action<SwaggerUIOptions, SwaggerConfigInfo>引數，可以實現自定義邏輯

2019.10.21

• 【Nuget】Magicodes.SwaggerUI 2.0.4
• 【升級】單個文件不分組，顯示所有API
• 【梳理】梳理目錄結構
• 【修復】修復本地開發環境執行時不載入文件註釋的問題
• 【修改】自動移除GroupUrlPrefix的前後空格以及“/”字首
• 【升級】在全域性隱藏API的基礎上，支援分組API隱藏
• 【升級】API隱藏支援HTTP方法配置，預設“*”

2019.10.19

• 【升級】支援API分組，支援非侵入式配置，無需修改程式碼，僅通過配置即可完成API分組（見下面示例）
• 【重構】重構整體邏輯

Demo

配置Demo

  "SwaggerDoc": {
    "IsEnabled": "true",
    //將列舉值以字串顯示
    "DescribeAllEnumsAsStrings": false,
    "SwaggerDocInfos": [
      {
        "IsEnabled": "true",
        "Title": "APP1 API文件",
        "Version": "v1",
        "GroupName": "App1",
        "Description": "",
        "Contact": {
          "Name": "心萊科技Team1",
          "Email": "[email protected]"
        },
        "GroupUrlPrefix": "api/app1/"
      },
      {
        "IsEnabled": "true",
        "Title": "APP2 API文件",
        "Version": "v2",
        "GroupName": "App2",
        "Description": "",
        "Contact": {
          "Name": "心萊科技Team2",
          "Email": "[email protected]"
        },
        "GroupUrlPrefix": "api/app2/",
        "HiddenApi": {
          "IsEnabled": "true",
          "Urls": [
            {
              "Url": "app2/Values/{id}",
              "HttpMethod": "Delete"
            }
          ]
        }
      }
    ],
    "HiddenApi": {
      "IsEnabled": "true",
      "Urls": [
        { "Url": "app1/Values/{id}" }
      ]
    },
    "UseFullNameForSchemaId": "false"
  }

注入程式碼:

//新增自定義API文件生成(支援文件配置)
public IServiceProvider ConfigureServices(IServiceCollection services)
{
services.AddMagicodesSwaggerGen(_appConfiguration);
}

public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
{
//啟用自定義API文件(支援文件配置)
app.UseMagicodesSwaggerUI(_appConfiguration);
}

特點

• 通過配置檔案簡單配置即可完成SwaggerUI的API格式JSON生成和整合

• 支援API分組和隱藏

• 支援自定義頁面和驗證

Nuget包

Magicodes Nuget包推薦

相關Nuget包

聯絡我們

其他開源庫

• https://github.com/xin-lai
• https://gitee.com/magicodes