1、使用nuget安装Swashbuckle.AspNetCore
2、指定生成的xml路径:在项目上右键点击“属性–>生成–>输出–>XML文档文件”
3、修改Startup.cs,再ConfigureService方法中添加如下代码:注意SwaggerDoc方法的第一个参数与OpenApiInfo的属性Version必须一致
//添加Swagger
services.AddSwaggerGen(option =>
{
option.SwaggerDoc("v1", new OpenApiInfo
{
Version = "v1",
Title = "Lanyp.App Swagger",
Description = "基于.NET Core 3.1 的Api Swagger"
});
// 加载程序集的xml描述文档
var baseDirectory = System.AppDomain.CurrentDomain.BaseDirectory;
//改文件名是从项目 “属性-->生成-->输出-->XML文档文件” 中得到的 或者为(System.AppDomain.CurrentDomain.FriendlyName + ".xml";)
var xmlFile = "WebApi.xml";
var xmlPath = Path.Combine(baseDirectory, xmlFile);
option.IncludeXmlComments(xmlPath);
});
如图
4、修改Configure方法
//启用中间件服务生成Swagger作为JSON终结点
app.UseSwagger();
//启用中间件服务对swagger-ui,指定Swagger JSON终结点
app.UseSwaggerUI(option =>
{
option.SwaggerEndpoint("/swagger/v1/swagger.json", "Lanyp.App version 1.0");
});
如图