How can I create an example requestBody in OpenAPI using MinimalApi?

Question

I'm trying to dynamically build a MinimalApi in ASP.Net Core application and I'm struggling with generating a requestBody example.

I tried to solved it like this:

.WithOpenApi(x =>
{
    x.RequestBody = new()
    {
        Content = new Dictionary<string, OpenApiMediaType>()
        {
            { "application/json", new OpenApiMediaType() { Example = new OpenApiString(JsonSerializer.Serialize(new TestClass())) } }
        }
    };
}

I'm getting an error 😱 Could not render Dt, see the console. when I open a method in Swagger-UI.

In the console, I have a message TypeError: Cannot read properties of undefined (reading 'toJS').

What is wrong with my approach and how can I set an example of requestBody in OpenAPI?

GeorgeKarlinzer · Accepted Answer · 2023-12-11 15:26:56Z

1

I've figured that out. I was missing a Scheme parameter in my OpenApiMediaType. The complete solution looks like this:

.WithOpenApi(x =>
{
    var scheme = new OpenApiSchema()
    {
        Type = typeof(TestClass).ToString(),
        Example = new OpenApiString(JsonSerializer.Serialize(new TestClass()))
    };
    x.RequestBody = new()
    {
        Content = new Dictionary<string, OpenApiMediaType>()
        {
            ["application/json"] = new()
            {
                 Schema = scheme
            }
        }
    };
}

answered Dec 11, 2023 at 15:26

GeorgeKarlinzer

6795 silver badges18 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Jeremy Feb 4 at 15:19

what are we using WithOpenApi for? I ask because it doesn't actually augment the OpenAPI document generation, and so doesn't impact the swagger UI if you have one.

GeorgeKarlinzer Feb 5 at 11:08

I call WithOpenApi per endpoint on RouteHandlerBuilder to specify open api documentation for the endpoint. It definitely impacts the swagger UI. For example endpointRouteBuilder.MapRoute(...).WithOpenApi(x => x.Summary = "Some summary") adds summary to the open api documentation as well as to the swagger.

Trey Mack Nov 24 at 16:47

Yikes. This makes me want to go back to generating code from a hand-written API spec. Thanks for the info though.

Collectives™ on Stack Overflow

How can I create an example requestBody in OpenAPI using MinimalApi?

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related