如何从 jsonresult 响应自动生成 openapi 文档？

[ad_1]

Swashbuckle可以根据代码自动生成API文档（有详细信息返回模型）

C＃

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

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

它包括关于模式、json 示例值等。

有没有办法让Swashbuckle自动生成API文档JsonResult？

C＃

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

    json.StatusCode = StatusCodes.Status200OK;

    return json;
}

我尝试过的：

在google、stackoverflow上搜索很多

解决方案1

开箱即用，您无法自动生成 JsonResult 的 API 文档。由于您没有返回具体类型，并且没有为特定结果定义明确的结构，因此 Swashbuckle 很难知道要生成什么。相反，您可以在代码中添加 SwaggerResponse 来说明返回的内容。

[ad_2]