Làm cách nào để tự động tạo tài liệu openapi từ phản hồi jsonresult?

lập trình


Swashbuckle có thể tự động tạo tài liệu API dựa trên mã (có mô hình trả về chi tiết)

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

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

Nó bao gồm về các lược đồ, giá trị ví dụ như json, v.v.

Có cách nào để Swashbuckle tự động tạo tài liệu API JsonResult không?

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

    json.StatusCode = StatusCodes.Status200OK;

    return json;
}

Những gì tôi đã thử:

nhiều tìm kiếm trên google, stackoverflow

Giải pháp 1

Ngay lập tức, bạn không thể tự động tạo tài liệu API cho JsonResult. Vì bạn không trả về một loại cụ thể, với cấu trúc được xác định rõ ràng cho một kết quả cụ thể, nên Swashbuckle khó biết phải sản xuất cái gì. Thay vào đó, những gì bạn có thể làm là thêm SwaggerResponse vào mã của mình để cho biết nội dung nào được trả về.

コメント

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