How to add method description in Swagger UI when using minimal APIs using dotnet 6.0?

Question

This link has amazing documentation on how to add documentation into swagger UI.

The problem with that link is that it does not show how to do so using minimal APIs. There are a lot of places on the internet that show how to add documentation to swagger UI such as this other question from stack overflow but I have not been able to do so using minimal apis.

This video shows how to create a simple project using minimal apis:
This video shows how to make it unit testable
This last video shows how to add validation, authorization and authentication

Has anyone managed to add custom documentation into swagger UI using minimal APIs?

Does this answer your question? How to add example responses in Swagger in a ASP .NET minimal API? — Michael Freidgeim
– Michael Freidgeim, Commented Dec 16, 2023 at 11:53

Mateusz D · Accepted Answer · 2022-03-29 19:48:37Z

4

According to Microsoft documentation there is support for minimal api.

app.MapGet("/api/todoitems/{id}", async (int id, TodoDb db) =>
         await db.Todos.FindAsync(id) 
         is Todo todo
         ? Results.Ok(todo) 
         : Results.NotFound())
   .Produces<Todo>(StatusCodes.Status200OK)
   .Produces(StatusCodes.Status404NotFound);

More info you can find here:

https://learn.microsoft.com/en-us/aspnet/core/fundamentals/minimal-apis?view=aspnetcore-6.0#openapi

edited Mar 29, 2022 at 19:48

answered Mar 29, 2022 at 19:42

Mateusz D

3481 gold badge2 silver badges9 bronze badges

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

Collectives™ on Stack Overflow

How to add method description in Swagger UI when using minimal APIs using dotnet 6.0?

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related