👁 Image
MicroCloud.Swagger 8.0.3.1

MicroCloud Swagger API 文档生成组件

说明

集成 Swagger API 文档生成组件，方便前后端分离的开发模式中前后端开发人员的数据接口对接工作。基于Swagger的工作原理，API的输入输出都需使用强类型的数据类型，Swagger才能发挥更好的作用，而MicroCloud框架通过AutoMapper的ProjectTo对业务实体到输出DTOIOutputDto提供了自动映射功能，能有效减轻后端开发中数据对象属性映射的工作量。

用法

可按照如下配置方式使用：

1. 通过nuget引用 MicroCloud.Swagger 程序集

Install-Package MicroCloud.Swagger

2. 在 appsettings.json 中 的 MicroCloud 节点下添加如下配置节点

{
 "Swagger": {
 "UI": "knife4j", //界面样式：knife4j、swagger(默认)。
 "IsHideSchemas": true, //隐藏架构
 "MiniProfiler": true, //启用轻量级工具分析
 // 注释文档
 "XmlPattern": "microcloud*.xml",
 //分组集合
 "Groups": [
 {
 "Name": "api", //名称
 "Title": "框架API", //标题
 "Description": "框架API", //描述
 "Url": "", //Url
 "Visible": true //是否可见
 },
 {
 "Name": "buss", //名称
 "Title": "业务API", //标题
 "Description": "业务API", //描述
 "Url": "/swagger/buss/swagger.json", //Url
 "Visible": false //是否可见
 }
 ],
 "Enabled": true //是否启用
 }
}

3. 要禁用Swagger，可以设置Enabled: false