0
286
Views¿Cómo agrupar puntos finales de FastAPI en la interfaz de usuario de Swagger?
Comencé a programar usando el marco fastApi y viene con una interfaz swagger incorporada para manejar solicitudes y respuestas. He completado casi 20 apis y es difícil administrar y reconocer apis en la interfaz de swagger. Alguien me dijo que agregara secciones en la interfaz de Swagger para distinguir las API, pero no pude encontrar ningún ejemplo en Google y necesito su ayuda.
Gracias por adelantado...
·
Santiago Trujillo
1 answers
Answer question0
Puede agregar etiquetas a su parámetro de ruta, por ejemplo.
Si tiene algo como esto, usar etiquetas es extremadamente útil.
@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 
Obtendrá esto, también si desea agregar una descripción y no quiere seguir repitiéndose (por ejemplo, agregando la misma descripción en todos los parámetros)
Puedes usar openapi_tags (prefiero esto)
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(): returnEsto le dará el mismo aspecto sin repetición.
·
Santiago Trujillo
Report
Answer question