MicroCloud.Swagger
8.0.3.1
dotnet add package MicroCloud.Swagger --version 8.0.3.1
NuGet\Install-Package MicroCloud.Swagger -Version 8.0.3.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MicroCloud.Swagger" Version="8.0.3.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add MicroCloud.Swagger --version 8.0.3.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: MicroCloud.Swagger, 8.0.3.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install MicroCloud.Swagger as a Cake Addin #addin nuget:?package=MicroCloud.Swagger&version=8.0.3.1 // Install MicroCloud.Swagger as a Cake Tool #tool nuget:?package=MicroCloud.Swagger&version=8.0.3.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
MicroCloud Swagger API 文档生成组件
说明
集成 Swagger
API 文档生成组件,方便前后端分离的开发模式中前后端开发人员的数据接口对接工作。基于Swagger
的工作原理,API的输入输出都需使用强类型
的数据类型,Swagger
才能发挥更好的作用,而MicroCloud框架通过AutoMapper
的ProjectTo
对业务实体到输出DTOIOutputDto
提供了自动映射功能,能有效减轻后端开发中数据对象属性映射的工作量。
用法
可按照如下配置方式使用:
- 通过nuget引用
MicroCloud.Swagger
程序集
Install-Package MicroCloud.Swagger
- 在
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 //是否启用
}
}
- 要禁用Swagger,可以设置
Enabled: false
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- MicroCloud.MiniProfiler (>= 8.0.3.1)
- Swashbuckle.AspNetCore (>= 6.7.3)
- Swashbuckle.AspNetCore.Newtonsoft (>= 6.7.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
8.0.3.1 | 105 | 9/9/2024 |
8.0.2.9 | 114 | 9/5/2024 |
8.0.2.8 | 100 | 8/31/2024 |
8.0.2.7 | 100 | 8/31/2024 |
8.0.2.6 | 130 | 8/21/2024 |
8.0.2.5 | 139 | 8/21/2024 |
8.0.2.4 | 124 | 8/12/2024 |
8.0.2.3 | 113 | 8/8/2024 |
8.0.2.2 | 111 | 7/14/2024 |
8.0.2.1 | 98 | 6/7/2024 |
8.0.1.9 | 94 | 6/6/2024 |
8.0.1.8 | 95 | 6/6/2024 |
8.0.1.7 | 118 | 5/15/2024 |
8.0.1.6 | 102 | 5/15/2024 |
8.0.1.5 | 124 | 5/15/2024 |
8.0.1.4 | 112 | 5/14/2024 |
8.0.1.3 | 113 | 5/10/2024 |
8.0.1.2 | 139 | 5/8/2024 |
8.0.1.1 | 116 | 5/7/2024 |
8.0.0.9 | 113 | 5/1/2024 |
8.0.0.8 | 118 | 5/1/2024 |
8.0.0.7 | 135 | 4/30/2024 |
8.0.0.5 | 121 | 4/19/2024 |
8.0.0.4 | 115 | 4/18/2024 |
8.0.0.3 | 130 | 4/15/2024 |
8.0.0.2 | 127 | 4/12/2024 |
8.0.0.1 | 122 | 4/12/2024 |
7.2.0.8 | 121 | 4/12/2024 |
7.2.0.7 | 114 | 4/12/2024 |
7.2.0.6 | 126 | 4/12/2024 |
7.2.0.5 | 125 | 4/12/2024 |
7.2.0.4 | 135 | 4/11/2024 |
7.2.0.2 | 140 | 4/7/2024 |
7.2.0.1 | 317 | 10/26/2023 |
7.1.2.9 | 143 | 11/7/2023 |
7.1.2.8 | 157 | 10/19/2023 |
7.1.2.7 | 154 | 10/19/2023 |
7.1.2.6 | 152 | 10/18/2023 |
7.1.2.4 | 161 | 9/13/2023 |
7.1.2.3 | 141 | 9/13/2023 |
7.1.2.2 | 135 | 9/12/2023 |
7.1.2.1 | 132 | 9/4/2023 |
7.1.1.9 | 177 | 8/31/2023 |
7.1.1.6 | 158 | 8/29/2023 |
7.1.1.5 | 140 | 8/25/2023 |
7.1.1.4 | 140 | 8/25/2023 |
7.1.1.3 | 168 | 8/25/2023 |
7.1.1.2 | 162 | 8/24/2023 |
7.1.1.1 | 154 | 8/24/2023 |
7.0.3.1 | 164 | 8/24/2023 |
7.0.2.7 | 146 | 5/12/2023 |
7.0.2.6 | 175 | 5/11/2023 |
7.0.1.7 | 155 | 5/9/2023 |
7.0.1.6 | 149 | 5/9/2023 |
7.0.1.4 | 185 | 4/24/2023 |
7.0.1.3 | 194 | 4/19/2023 |
7.0.1.2 | 196 | 4/19/2023 |
7.0.0.9 | 188 | 4/18/2023 |
7.0.0.8 | 196 | 4/17/2023 |
7.0.0.7 | 188 | 4/12/2023 |
7.0.0.6 | 195 | 4/8/2023 |
7.0.0.5 | 199 | 4/7/2023 |
7.0.0.4 | 211 | 4/7/2023 |
7.0.0.3 | 195 | 4/7/2023 |