OpenApiDocumentTransformerContext.DescriptionGroups Propriedade

public System.Collections.Generic.IReadOnlyList<Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroup> DescriptionGroups { get; init; }

member this.DescriptionGroups : System.Collections.Generic.IReadOnlyList<Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroup> with get, set

Public Property DescriptionGroups As IReadOnlyList(Of ApiDescriptionGroup)

Valor da propriedade

Exemplos

// Filter to only the API descriptions included in this document
var options = context.ApplicationServices
    .GetRequiredService<IOptionsMonitor<OpenApiOptions>>()
    .Get(context.DocumentName);
var descriptions = context.DescriptionGroups
    .SelectMany(g => g.Items)
    .Where(options.ShouldInclude);
foreach (var description in descriptions)
{
    Console.WriteLine($"{description.HttpMethod} {description.RelativePath}");
}

Comentários

Cada ApiDescriptionGroup um contém uma coleção de ApiDescription itens que descrevem pontos de extremidade de API. Essas descrições fornecem metadados sobre cada ponto de extremidade, como o método HTTP, o caminho relativo, os formatos de solicitação/resposta com suporte e os parâmetros.

Essa propriedade contém todas as descrições de API do aplicativo, não apenas os pontos de extremidade incluídos no documento atual. Para determinar quais descrições correspondem aos pontos de extremidade neste documento, use ShouldInclude para filtrar as descrições.