OpenApiDocumentTransformerContext.DescriptionGroups Eigenschaft

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)

Eigenschaftswert

Beispiele

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

Hinweise

Jede ApiDescriptionGroup enthält eine Sammlung von ApiDescription Elementen, die API-Endpunkte beschreiben. Diese Beschreibungen stellen Metadaten zu jedem Endpunkt bereit, z. B. die HTTP-Methode, relativer Pfad, unterstützte Anforderungs-/Antwortformate und Parameter.

Diese Eigenschaft enthält alle API-Beschreibungen aus der Anwendung, nicht nur die Endpunkte, die im aktuellen Dokument enthalten sind. Verwenden Sie ShouldInclude zum Filtern der Beschreibungen, um zu bestimmen, welche Beschreibungen Endpunkten in diesem Dokument entsprechen.