jsonresult प्रतिक्रिया से स्वचालित रूप से openapi दस्तावेज़ कैसे उत्पन्न करें?

[ad_1]

स्वैशबकल स्वचालित रूप से कोड के आधार पर एपीआई दस्तावेज़ तैयार कर सकता है (विवरण रिटर्न मॉडल के साथ)

सी#
[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, stackoverflow पर खोजते हैं

समाधान 1

बॉक्स से बाहर, आप JsonResult के लिए स्वचालित रूप से API दस्तावेज़ तैयार नहीं कर सकते। चूंकि आप किसी विशेष परिणाम के लिए एक अच्छी तरह से परिभाषित संरचना के साथ एक ठोस प्रकार नहीं लौटा रहे हैं, इसलिए स्वाशबकल के लिए यह जानना मुश्किल है कि क्या उत्पादन करना है। इसके बजाय, आप यह कर सकते हैं कि क्या लौटाया जा रहा है, यह बताने के लिए अपने कोड में एक स्वैगररिस्पॉन्स जोड़ें।

[ad_2]

コメント

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