¿Cómo generar automáticamente una documentación de openapi a partir de una respuesta jsonresult?

programación


Swashbuckle puede generar automáticamente documentación API basada en código (con modelo de devolución de detalles)

C#
[HttpGet]
public ActionResult<List<Student>> GetStudents()
{
    return CollegeRepository.Students;
}

https://i.stack.imgur.com/hHGze.png

Incluye esquemas, valores de ejemplo como json, etc.

¿Hay alguna forma de hacer que Swashbuckle genere automáticamente la documentación API como JsonResult?

C#
[HttpGet]
public JsonResult GetStudents()
{
    var json = new JsonResult(new
    {
        data = CollegeRepository.Students,
        message = "success"
    });

    json.StatusCode = StatusCodes.Status200OK;

    return json;
}

Lo que he probado:

muchos buscan en google, stackoverflow

Solución 1

De fábrica, no puede generar automáticamente documentación API para JsonResult. Como no estás devolviendo un tipo concreto, con una estructura bien definida para un resultado particular, es difícil para Swashbuckle saber qué producir. En cambio, lo que puede hacer es agregar SwaggerResponse a su código para indicar qué se devuelve.

コメント

タイトルとURLをコピーしました