OpenApiDocumentTransformerContext.DescriptionGroups Proprietà

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)

Valore della proprietà

Esempio

// 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}");
}

Commenti

Ogni ApiDescriptionGroup contiene una raccolta di ApiDescription elementi che descrivono gli endpoint API. Queste descrizioni forniscono metadati su ogni endpoint, ad esempio il metodo HTTP, il percorso relativo, i formati di richiesta/risposta supportati e i parametri.

Questa proprietà contiene tutte le descrizioni API dell'applicazione, non solo gli endpoint inclusi nel documento corrente. Per determinare quali descrizioni corrispondono agli endpoint in questo documento, usare ShouldInclude per filtrare le descrizioni.