Empresas
Empregos
  • Sobre nós
  • Soluções
    • Publicação de vagas
      Publique sua vaga e receba candidatos qualificados em 48h.
    • Avaliações de candidatos
      Mais de 500 testes técnicos e psicológicos, mais anti-fraude.
    • Headhunting
      Busca executiva personalizada do início ao fim.
    • Folha de Pagamento + EOR
      Dispersão de folha e EOR em mais de 15 países da LATAM.
  • Preços
  • Empregos

0

292
Visualizações
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 apis on swagger interface. Someone told me to add sections in swagger interface to distinguish apis, but I couldn't find any examples on google and I need help from you guys.

Thanks in advance...

over 4 years ago · Santiago Trujillo
1 Respostas
Responde à pergunta

0

You can add tags to your path parameter, for example.

If you have something like this, using tags is extremely helpful.

@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


@app.get("/something", tags=["Get Methods"])
async def something():
    return

enter image description here

You will get this, also if you want to add description and you don't want to keep repating yourself (For example adding same description in all parameters)

You can use openapi_tags (I prefer this)

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

This will give the same look without repetition

enter image description here

over 4 years ago · Santiago Trujillo Relatório
Responde à pergunta
Encontrar trabalhos remotos

Descubra a nova forma de encontrar um emprego!

melhores empregos
Principais categorias de trabalho
Empresas
Postar vaga Preços Comercial
Jurídico
Termos e Condições Política de privacidade
© 2026 PeakU Inc. All Rights Reserved.
Andres GPT
Recomende algumas ofertas para mim
Preciso de ajuda