文章目录
- Swagger
- 添加Swagger注释
Swagger
添加Swagger注释
1、右击项目->选择属性->点击生成->输出,选中文档文件
2、配置服务
在program.cs
文件里配置SwaggerUI
//增加项一
builder.Services.AddSwaggerGen(c=> {
c.SwaggerDoc("v1", new OpenApiInfo { Title = "Web API", Version = "v1" });
var xmlFile = $"{Assembly.GetEntryAssembly().GetName().Name}.xml";
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
c.IncludeXmlComments(xmlPath);
});
//增加项二
if (app.Environment.IsDevelopment())
{
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});
}
3、在控制器的方法上加上注释即可在swagger网页上看到注释