Idea: Improvements to Default OpenAPI Descriptions

1. Produces 200 is always set. This is a reasonable default; however, how can we handle cases where the endpoint may only return, for example, just a 201? The Swagger doc will output a 200 where that endpoint doesn’t return that. Describe() with clearDefaults=true would require you to have to describe everything again, not just the sucessful response(s), and potentially missing other defaults for an endpoint.

2. Since endpoints are authorized by default, would it be good to add in a default for 401? AnonymousVerbs is empty unless AllowAnonymous is set for any verb. On an aside, I believe there isn’t a way yet to set Produces for different verbs, but for now, here’s an example:

if (Definition.AnonymousVerbs?.Any() != true)
{
    b.Produces(401);
}

What are your thoughts?

[austins]

You’re right, Just tried the changes out. It works good so far. Thanks again! 💯

[dj-nitehawk]

done in 5.8.1.13-beta

however, FastEndpoints.ProblemDetails class is not the default. FastEndpoints.ErrorResponse is.

if you want to make ProblemDetails the default you’d have to do this to change the default:

app.UseFastEndpoints(config =>
{
    config.Errors.UseProblemDetails();
});