使用Magicodes.SwaggerUI快速配置SwaggerUI以及設置API分組

Magicodes.SwaggerUI

快速配置和集成SwaggerUI

特點

• 通過配置文件簡單配置即可完成SwaggerUI的API格式JSON生成和集成

• 支持API分組和隱藏

• 支持自定義頁面和驗證

Nuget包

 

 

聯系我們

訂閱號

關注“麥扣聊技術”微信訂閱號可以獲得最新文章、教程、文檔。

QQ群

• 編程交流群<85318032>

• 產品交流群<897857351>

文檔官網&官方博客

• 文檔官網：https://docs.xin-lai.com/

• 博客：http://www.cnblogs.com/codelove/

其他開源庫

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

• https://gitee.com/magicodes

更新日志

2019.10.21

• 【Nuget】Magicodes.SwaggerUI 2.0.1

• 【升級】單個文檔不分組，顯示所有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": "[e-mail]"
        },
        "GroupUrlPrefix": "api/app1/"
      },
      {
        "IsEnabled": "true",
        "Title": "APP2 API文檔",
        "Version": "v2",
        "GroupName": "App2",
        "Description": "",
        "Contact": {
          "Name": "心萊科技Team2",
          "Email": "[e-mail]"
        },
        "GroupUrlPrefix": "api/app2/"
      }
    ],
    "HiddenApi": {
      "IsEnabled": "true",
      "HiddenUrls": "app1/Values/{id}"
    },
    "UseFullNameForSchemaId": "false"
  }

注入代碼:

//添加自定義API文檔生成(支持文檔配置)
public IServiceProvider ConfigureServices(IServiceCollection services)
{
services.AddCustomSwaggerGen(_appConfiguration);
}

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