💭 How to group FastAPI endpoints in Swagger UI?
===============================================

!https://stackoverflow.com/questions/63762387/how-to-group-fastapi-endpoints-in-swagger-ui#answer-63762765

Date: December 15, 2023

How to group FastAPI endpoints in Swagger UI?
 I started programming using FastAPI framework and it comes with a builtin Swagger interface to handle requests and responses.
I have completed nearly 20 APIs and its hard to manage and recognise AP...
 Stack Overflow · stackoverflow.com [1]

 Setting tags in your fastapi endpoints will group them in the docs. You can also set some metadata around the tags to get nice descriptions.

Here is a full example from the post.

``` python
from fastapi import FastAPI

tags_metadata = [
 {"name": "Get Methods", "description": "One other way around"},
 {"name": "Post Methods", "description": "Keep doing this"},
 {"name": "Delete Methods", "description": "KILL 'EM ALL"},
 {"name": "Put Methods", "description": "Boring"},
]

app = FastAPI(openapi_tags=tags_metadata)

@app.delete("/items", tags=["Delete Methods"])
@app.put("/items", tags=["Put Methods"])
@app.post("/items", tags=["Post Methods"])
@app.get("/items", tags=["Get Methods"])
async def handle_items():
 return
```

!!! note

 This post is a thought [2]. It's a short note that I make
 about someone else's content online #thoughts [3]

References:
[1]: https://stackoverflow.com/questions/63762387/how-to-group-fastapi-endpoints-in-swagger-ui#answer-63762765
[2]: /thoughts/
[3]: /tags/thoughts/