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": "xinlai@xin-lai.com"
        },
        "GroupUrlPrefix": "api/app1/"
      },
      {
        "IsEnabled": "true",
        "Title": "APP2 API文檔",
        "Version": "v2",
        "GroupName": "App2",
        "Description": "",
        "Contact": {
          "Name": "心萊科技Team2",
          "Email": "xinlai@xin-lai.com"
        },
        "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包

名稱	Nuget
Magicodes.SwaggerUI

Magicodes Nuget包推薦

相關Nuget包

名稱	說明	GitHUb
Magicodes.IE.Excel	Excel導入導出	dotnetcore/Magicodes.IE
Magicodes.IE.Core	導入導出核心庫	dotnetcore/Magicodes.IE
Magicodes.IE.HTML	HTML導入導出	dotnetcore/Magicodes.IE
Magicodes.IE.Pdf	Pdf導出	dotnetcore/Magicodes.IE
Magicodes.IE.Word	Word導出	dotnetcore/Magicodes.IE
Magicodes.IE.Csv	Csv導入導出	dotnetcore/Magicodes.IE
Magicodes.WeChat.MiniProgram	小程序SDK	Magicodes.WxMiniProgram.Sdk
Magicodes.Sms.Aliyun	阿里雲短信	xin-lai/Magicodes.Sms
Magicodes.Sms.Core	短信核心庫	xin-lai/Magicodes.Sms
Magicodes.Sms.Aliyun.Abp	阿里雲短信Abp模塊	xin-lai/Magicodes.Sms
Magicodes.Storage.Core	通用存儲核心庫	xin-lai/Magicodes.Storage
Magicodes.Storage.AliyunOss.Core	阿里雲OSS存儲	xin-lai/Magicodes.Storage
Magicodes.Storage.Local.Core	本地存儲	xin-lai/Magicodes.Storage
Magicodes.Storage.Tencent.Core	騰訊雲存儲	xin-lai/Magicodes.Storage
Magicodes.Storage.Abp.Core	通用存儲ABP模塊集成	xin-lai/Magicodes.Storage
Magicodes.WeChat.SDK.Core	微信SDK	xin-lai/Magicodes.WeChat.SDK
Magicodes.SwaggerUI	SwaggerUI API快速配置和分組	xin-lai/Magicodes.SwaggerUI
Magicodes.Pay.Alipay	支付寶支付庫	xin-lai/Magicodes.Pay
Magicodes.Pay.Notify	支付通用回調庫	xin-lai/Magicodes.Pay
Magicodes.Pay.Wxpay	微信支付庫	xin-lai/Magicodes.Pay
Magicodes.Pay.Alipay.Global	國際支付寶支付庫	xin-lai/Magicodes.Pay
Magicodes.Pay.Allinpay	通聯支付庫	xin-lai/Magicodes.Pay
Magicodes.Pay.Abp	ABP 支付通用封裝庫	xin-lai/Magicodes.Pay
Magicodes.Pay.Abp.Allinpay	ABP 通聯支付模塊	xin-lai/Magicodes.Pay
Magicodes.Pay.Abp.Wxpay	ABP 微信支付模塊	xin-lai/Magicodes.Pay
Magicodes.Pay.Alipay.Global	ABP 國際支付寶模塊	xin-lai/Magicodes.Pay
Magicodes.Pay.Alipay	ABP 支付寶模塊	xin-lai/Magicodes.Pay
Magicodes.Abp.Castle.NLog	ABP Nlog支持模塊	xin-lai/Abp.Castle.NLog
Magicodes.WxMiniProgram.Sdk	微信小程序SDK	xin-lai/Magicodes.WxMiniProgram.Sdk
Magicodes.WxMiniProgram.Sdk.Abp	微信小程序SDK Abp模塊	xin-lai/Magicodes.WxMiniProgram.Sdk
Magicodes.Dingtalk.SDK	釘釘SDK	xin-lai/Magicodes.Dingtalk.SDK
Magicodes.DynamicSqlApi.Core	根據SQL自動解析生成動態API	Magicodes.DynamicSqlApi
Magicodes.DynamicSqlApi.All	根據SQL自動解析生成動態API	Magicodes.DynamicSqlApi
Magicodes.DynamicSqlApi.CsScript	根據SQL自動解析生成動態API	Magicodes.DynamicSqlApi
Magicodes.DynamicSqlApi.Dapper	根據SQL自動解析生成動態API	Magicodes.DynamicSqlApi
Magicodes.DynamicSqlApi.SqlServer	根據SQL自動解析生成動態API	Magicodes.DynamicSqlApi