How to automatically generate an openapi documentation from a jsonresult response?

Question

0.00/5 (No votes)

See more:

Swashbuckle can automatically generates API documentation based on code (with details return model)

C#

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

https://i.stack.imgur.com/hHGze.png
It includes about schemas, example value as json, etc.

Is there any way to make Swashbuckle automatically generates API documentation a JsonResult?

C#

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

    json.StatusCode = StatusCodes.Status200OK;

    return json;
}

What I have tried:

many search on google, stackoverflow

Posted 7-Jan-24 17:11pm

GinCanhViet

Add a Solution

1 solution

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Pete O'Hanlon · Accepted Answer · 2024-01-07T18:35:00

Out of the box, you can't automatically generate API documentation for JsonResult. As you aren't returning a concrete type, with a well defined structure for a particular result, it's difficult for Swashbuckle to know what to produce. What you can do, instead, is add a SwaggerResponse to your code to say what's being returned.