WebApi コントローラーの概要が Swagger ドキュメントに表示されない 質問する

WebApi コントローラーの概要が Swagger ドキュメントに表示されない 質問する

Swagger を通じてこのドキュメント機能を有効にすると、ドキュメントに関するあらゆる種類の情報を表示できますが、コントローラー名の詳細/説明については詳細が表示されません。

以下の例のようにコントローラーのドキュメントコンテンツを表示するにはどうすればよいですか?

/// <summary> 

/// Represents the alert api controller class.

/// <summary>

public class XYZController : ApiController
{

}

Swaggerを有効にすると、このコンテンツをどこにも表示できなくなりますRepresents the XYZ api controller class. here

ただし、すべてのメソッドの説明を見ることはできます。

ベストアンサー1

1.) プロジェクトを右クリックし、projname.csprojを編集して以下を追加します。

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>

2.) ConfigureServicesのAddSwaggerGenに以下を追加します。

  // Set the comments path for the Swagger JSON and UI.
                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                c.IncludeXmlComments(xmlPath);

詳細については、以下をご覧ください。

https://learn.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-5.0&tabs=visual-studio

おすすめ記事