微软官方文档 :Swagger文档
局部取消xml 警告:#pragma warning disable 1591
全局:
<PropertyGroup>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<NoWarn>$(NoWarn);1591</NoWarn>
</PropertyGroup>
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "MyApi", Version = "v1" });
var xmlPath = Path.Combine(AppContext.BaseDirectory, "Swagger.xml");
c.AddEnumsWithValuesFixFilters(services, o => //枚举显示
{
o.ApplySchemaFilter = true;
o.ApplyDocumentFilter = true;
o.IncludeDescriptions = true;
o.IncludeXEnumRemarks = true;
o.DescriptionSource =
DescriptionSources.DescriptionAttributesThenXmlComments;
o.IncludeXmlCommentsFrom(xmlPath);
});
c.IncludeXmlComments(xmlPath);
});
app.UseSwagger(c => {
c.RouteTemplate = "swagger/{documentName}/swagger.json";
});
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("v1/swagger.json", "Swagger");
});