ASP.NET Core Minimal API POST verb raw body swagger empty parameters

Question

I'm using an ASP.NET Core Minimal API, the POST operation reads raw data:

app.MapPost("/Authenticate", async (HttpRequest Request) => {
    string rawContent = string.Empty;
    using (var reader = new StreamReader(Request.Body,
                    encoding: Encoding.UTF8, detectEncodingFromByteOrderMarks: false))
    {
        rawContent = await reader.ReadToEndAsync();
    }
    // .......
})
.WithName("Authenticate")
.WithOpenApi();

When I run dotnet run command and it opens the browser with the Swagger UI, the endpoint parameters are not available, the endpoint works perfect using Postman + raw post data, but it would be nicer if Swagger UI would allow me to input the raw post body too...

Thank you

Tried with interfaces as input, same result, empty parameters @ Swagger UI ...

Is there a particular why do you want to read the body manually via stream? — Guru Stron
– Guru Stron, Commented Mar 16, 2024 at 17:16
That's how the client will post the data using raw data... I have multiple clients / partners where their API works with raw data, nothing new.. or probably too classic in other programming languages... — jany
– jany, Commented Mar 20, 2024 at 16:26
So you are saying that your clients can post any type of JSON with any structure without any kind of contract? — Guru Stron
– Guru Stron, Commented Mar 20, 2024 at 16:32

Yuning Duan · Accepted Answer · 2024-03-18 06:37:14Z

You can customize the OpenAPI to include a requestBody schema that accepts raw data. Here is an example you can use as a reference:

app.MapPost("/Authenticate", async (HttpRequest Request) =>
{
    string rawContent = string.Empty;
    using (var reader = new StreamReader(Request.Body,
                    encoding: Encoding.UTF8, detectEncodingFromByteOrderMarks: false))
    {
        rawContent = await reader.ReadToEndAsync();
    }
    
})
.WithName("Authenticate")
.WithOpenApi(openApi =>
{
    openApi.RequestBody = new OpenApiRequestBody
    {
        Content = new Dictionary<string, OpenApiMediaType>
        {
            {
                "application/json", new OpenApiMediaType
                {
                    Schema = new OpenApiSchema
                    {
                        Type = "object" 
                    }
                }
            }
        },
        Description = "JSON"
    };

    return openApi;
});

Collectives™ on Stack Overflow

ASP.NET Core Minimal API POST verb raw body swagger empty parameters

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related