Estoy tratando de ocultar toda la sección de esquemas de los documentos de swagger generados por FastAPI. Revisé los documentos y probé esto, pero la sección del esquema aún se muestra.
@Schema(hidden=True) class theSchema(BaseModel): category: str¿Cómo omito un esquema en particular o toda la sección de esquemas de los documentos de swagger devueltos?
docExpansion tampoco parece funcionar. ¿Qué me estoy perdiendo?
app = FastAPI( openapi_tags=tags_metadata, title="Documentation", description="API endpoints", version="0.1", docExpansion="None" )swagger tiene el parámetro de interfaz de usuario "defaultModelsExpandDepth" para controlar la vista de los modelos en la sección de esquema.
Este parámetro se puede reenviar mediante el parámetro "swagger_ui_parameters" en la inicialización de FastApi.
app = FastAPI(swagger_ui_parameters={"defaultModelsExpandDepth": -1})Valores:
Se pueden encontrar más opciones aquí: https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/
establezca include_in_schema=False en los argumentos del decorador de instancias de FastAPI en su lugar
app = FastAPI(...) @app.get("/", include_in_schema=False) async def root(): ...No estoy seguro de obtener puntos por responder mi propia pregunta, pero si alguien quiere saberlo, esto se resolvió cargando la página de swagger en un iframe y luego usando js para ocultar los elementos deseados dentro del iframe de ese documento.