在Swagger UI 中顯示Controller的描述字詞

Controller的描述字詞,如下圖所示:

顯示方法,兩種NuGet套件,也包含了顯示方法的註解

Swashbuckle:

1. Program.cs

Services.AddSwaggerGen(c =>

{

    var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";

    var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);

    c.IncludeXmlComments(xmlPath, includeControllerXmlComments: true);

});

NSwag:

1.Edit <project_name>.csproj,加入以下項目

<PropertyGroup>

  <GenerateDocumentationFile>true</GenerateDocumentationFile>

  <NoWarn>$(NoWarn);1591</NoWarn>

</PropertyGroup>

2.Program.cs

Services.AddSwaggerDocument(config =>

{

    config.UseControllerSummaryAsTagDescription = true;

});