OpenApiDocumentTransformerContext.DescriptionGroups Vlastnost

Definice

Obor názvů:

Microsoft.AspNetCore.OpenApi

Sestavení:

Microsoft.AspNetCore.OpenApi.dll

Balíček:

Microsoft.AspNetCore.OpenApi v10.0.0

Zdroj:

OpenApiDocumentTransformerContext.cs

Získá skupiny popisů rozhraní API pro aplikaci.

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)

Hodnota vlastnosti

IReadOnlyList<ApiDescriptionGroup>

Příklady

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

Poznámky

Každá ApiDescriptionGroup obsahuje kolekci ApiDescription položek, které popisují koncové body rozhraní API. Tyto popisy poskytují metadata o jednotlivých koncových bodech, jako je metoda HTTP, relativní cesta, podporované formáty požadavků a odpovědí a parametry.

Tato vlastnost obsahuje všechny popisy rozhraní API z aplikace, nejen koncové body zahrnuté v aktuálním dokumentu. Chcete-li zjistit, které popisy odpovídají koncovým bodům v tomto dokumentu, použijte ShouldInclude k filtrování popisů.