Utilizo Swagger en un proyecto de API web ASP.Net para generar una interfaz swagger, que funciona muy bien.

Digamos que tengo un método al que quiero agregar algunas explicaciones, ¿cómo puedo hacerlo?

Por comentario me refiero a algo que verá cuando un usuario de la API esté mirando la documentación.

He buscado en Google, me he mareado y ... ¿agachado? - pero no pude encontrar nada al respecto. Quizás estoy usando términos equivocados.

2
Kjensen 6 oct. 2020 a las 21:58

2 respuestas

La mejor respuesta

Puede utilizar Comentarios del documento para lograr tu objetivo. Por ejemplo

/// <summary>This method changes the point's location by
///    the given x- and y-offsets.
/// <example>For example:
/// <code>
///    Point p = new Point(3,5);
///    p.Translate(-1,3);
/// </code>
/// results in <c>p</c>'s having the value (2,8).
/// </example>
/// </summary>

public void Translate(int xor, int yor) {
    X += xor;
    Y += yor;
}

Translate es su método de API y ha agregado los comentarios de documentación adecuados. NSwag los recogerá y los mostrará cuando explore la API a través del explorador de API. Si eso no funciona, agregue siguiendo en su .csproj

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
  <NoWarn>$(NoWarn);1591</NoWarn>
</PropertyGroup>
1
Muhammad Hannan 6 oct. 2020 a las 21:46

Alternativamente al enfoque XML publicado en otra respuesta, puede usar Swashbuckle.AspNetCore.Annotations paquete también si prefiere un enfoque basado en atributos.

1
Ben Sampica 7 oct. 2020 a las 02:20