【解決方法】jsonresult 応答から openapi ドキュメントを自動的に生成するにはどうすればよいですか?

[ad_1]

Swashbuckle はコードに基づいて API ドキュメントを自動的に生成できます (詳細な戻りモデルを含む)

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

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

スキーマについて、json としての値の例などが含まれます。

Swashbuckle が API ドキュメントを JsonResult として自動的に生成するようにする方法はありますか?

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

    json.StatusCode = StatusCodes.Status200OK;

    return json;
}

私が試したこと:

Google、スタックオーバーフローでの検索が多い

解決策 1

そのままでは、JsonResult の API ドキュメントを自動的に生成することはできません。特定の結果に対して明確に定義された構造を備えた具体的な型を返すわけではないため、Swashbuckle が何を生成するかを知るのは困難です。代わりに、コードに SwaggerResponse を追加して、何が返されるかを示すことができます。

[ad_2]