OpenApiDocumentTransformerContext.DescriptionGroups Propriété

Définition

Espace de noms:

Microsoft.AspNetCore.OpenApi

Assembly:

Microsoft.AspNetCore.OpenApi.dll

Paquet:

Microsoft.AspNetCore.OpenApi v10.0.0

Source:

OpenApiDocumentTransformerContext.cs

Obtient les groupes de description d’API pour l’application.

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)

Valeur de propriété

IReadOnlyList<ApiDescriptionGroup>

Exemples

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

Remarques

Chacun ApiDescriptionGroup contient une collection d’éléments qui décrivent les points de terminaison d’API ApiDescription . Ces descriptions fournissent des métadonnées sur chaque point de terminaison, comme la méthode HTTP, le chemin relatif, les formats de requête/réponse pris en charge et les paramètres.

Cette propriété contient toutes les descriptions d’API de l’application, et non seulement les points de terminaison inclus dans le document actif. Pour déterminer quelles descriptions correspondent aux points de terminaison de ce document, utilisez cette option ShouldInclude pour filtrer les descriptions.