OpenApiDocumentTransformerContext.DescriptionGroups Propiedad

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 de propiedad

Ejemplos

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

Comentarios

Cada ApiDescriptionGroup contiene una colección de elementos que describen los puntos de conexión de ApiDescription API. Estas descripciones proporcionan metadatos sobre cada punto de conexión, como el método HTTP, la ruta de acceso relativa, los formatos de solicitud y respuesta admitidos y los parámetros.

Esta propiedad contiene todas las descripciones de API de la aplicación, no solo los puntos de conexión incluidos en el documento actual. Para determinar qué descripciones corresponden a los puntos de conexión de este documento, use ShouldInclude para filtrar las descripciones.