1.安装Nuget包:Swashbuckle.AspNetCore
2.使用Swagger中间件
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen(option =>
{
//要启用swagger版本控制要在api控制器或者方法上添加特性[ApiExplorerSettings(GroupName = "版本号")]
typeof(ApiVersions).GetEnumNames().ToList().ForEach(version =>
{
option.SwaggerDoc(version, new OpenApiInfo()
{
Title = $"{version}:Api文档",
Version = version,
Description = $"{version}"
});
});
// xml文档绝对路径,你的api.xml文件在项目属性=》生成=》输出=》文档文件,xml文件路径可选可不选
var file = Path.Combine(AppContext.BaseDirectory, "你的api.xml");
// true : 显示控制器层注释
option.IncludeXmlComments(file, true);
// 对action的名称进行排序,如果有多个,就可以看见效果了。
option.OrderActionsBy(o => o.RelativePath);
})
app.UseSwagger();
//配置swagger.json
app.UseSwaggerUI(option =>
{
foreach (string version in typeof(ApiVersions).GetEnumNames())
{
option.SwaggerEndpoint($"/swagger/{version}/swagger.json", $"{version}");
}
});
3.其中ApiVersions可以是枚举,可以是任何集合,只要能更好的操作就行了
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 物流快递公司核心技术能力-地址解析分单基础技术分享
· .NET 10首个预览版发布:重大改进与新特性概览!
· 单线程的Redis速度为什么快?
· 展开说说关于C#中ORM框架的用法!
· Pantheons:用 TypeScript 打造主流大模型对话的一站式集成库