Bagaimana cara menghasilkan dokumentasi openapi secara otomatis dari respons jsonresult?

pemrograman


Swashbuckle dapat secara otomatis menghasilkan dokumentasi API berdasarkan kode (dengan model pengembalian detail)

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

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

Ini mencakup tentang skema, contoh nilai sebagai json, dll.

Apakah ada cara untuk membuat Swashbuckle secara otomatis menghasilkan dokumentasi API menjadi JsonResult?

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

    json.StatusCode = StatusCodes.Status200OK;

    return json;
}

Apa yang saya coba:

banyak pencarian di google, stackoverflow

Solusi 1

Di luar kotak, Anda tidak dapat secara otomatis membuat dokumentasi API untuk JsonResult. Karena Anda tidak mengembalikan tipe beton, dengan struktur yang terdefinisi dengan baik untuk hasil tertentu, sulit bagi Swashbuckle untuk mengetahui apa yang harus diproduksi. Yang dapat Anda lakukan adalah menambahkan SwaggerResponse ke kode Anda untuk menyatakan apa yang dikembalikan.

コメント

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