快速配置和集成SwaggerUI

  • 通过配置文件简单配置即可完成SwaggerUI的API格式JSON生成和集成

  • 支持API分组和隐藏

  • 支持自定义页面和验证

 

 

关注“麦扣聊技术”微信订阅号可以获得最新文章、教程、文档。

  • 编程交流群<85318032>

  • 产品交流群<897857351>

  • 【Nuget】Magicodes.SwaggerUI 2.0.1

  • 【升级】单个文档不分组，显示所有API

  • 【梳理】梳理目录结构

  • 【修复】修复本地开发环境运行时不加载文档注释的问题

  • 【修改】自动移除GroupUrlPrefix的前后空格以及“/”前缀

  • 【升级】在全局隐藏API的基础上，支持分组API隐藏

  • 【升级】API隐藏支持HTTP方法配置，默认“*”

  • 【升级】支持API分组，支持非侵入式配置，无需修改代码，仅通过配置即可完成API分组（见下面示例）

  • 【重构】重构整体逻辑

  1.  "SwaggerDoc": {
  2.     "IsEnabled": "true",
  3.     //将枚举值以字符串显示
  4.     "DescribeAllEnumsAsStrings": false,
  5.     "SwaggerDocInfos": [
  6.       {
  7.         "IsEnabled": "true",
  8.         "Title": "APP1 API文档",
  9.         "Version": "v1",
  10.         "GroupName": "App1",
  11.         "Description": "",
  12.         "Contact": {
  13.           "Name": "心莱科技Team1",
  14.           "Email": "xinlai@xin-lai.com"
  15.         },
  16.         "GroupUrlPrefix": "api/app1/"
  17.       },
  18.       {
  19.         "IsEnabled": "true",
  20.         "Title": "APP2 API文档",
  21.         "Version": "v2",
  22.         "GroupName": "App2",
  23.         "Description": "",
  24.         "Contact": {
  25.           "Name": "心莱科技Team2",
  26.           "Email": "xinlai@xin-lai.com"
  27.         },
  28.         "GroupUrlPrefix": "api/app2/"
  29.       }
  30.     ],
  31.     "HiddenApi": {
  32.       "IsEnabled": "true",
  33.       "HiddenUrls": "app1/Values/{id}"
  34.     },
  35.     "UseFullNameForSchemaId": "false"
  36.   }
  1.  
  1. //添加自定义API文档生成(支持文档配置)
  2. public IServiceProvider ConfigureServices(IServiceCollection services)
  3. {
  4. services.AddCustomSwaggerGen(_appConfiguration);
  5. }
  7. public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
  8. {
  9. //启用自定义API文档(支持文档配置)
  10. app.UseCustomSwaggerUI(_appConfiguration);
  11. }

 

版权声明：本文为codelove原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://www.cnblogs.com/codelove/p/11819898.html