FastAPI - @Schema(hidden=True) not working when trying to hide the schema section on swagger docs

user_17842886 0
Viewed 2388

I'm trying to hide the entire schemas section of the FastAPI generated swagger docs. I've checked the docs and tried this but the schema section still shows.

    @Schema(hidden=True)
    class theSchema(BaseModel):
        category: str

How do I omit one particular schema or the entire schemas section from the returned swagger docs.

docExpansion does not appear to work either. What am I missing?

app = FastAPI(
    openapi_tags=tags_metadata,
    title="Documentation",
    description="API endpoints",
    version="0.1",
    docExpansion="None"
)
fastapi swagger openapi python
3 Answers

set include_in_schema=False in the args to the FastAPI instance decorator instead

app = FastAPI(...)

@app.get("/", include_in_schema=False)
async def root():
    ...
user_45410450

swagger has the UI parameter "defaultModelsExpandDepth" for controlling models' view in the schema section.

This parameter can be forwarded using "swagger_ui_parameters" parameter on FastApi initialization.

app = FastAPI(swagger_ui_parameters={"defaultModelsExpandDepth": -1})

Values:

  • -1: schema section hidden
  • 0: schema section is closed
  • 1: schema section is open (default)

More options can be found here: https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/

user_50168400

Not sure if I get points for answering my own question but if anyone wants to know, this was resolved by loading the swagger page into an iframe then using js to hide the desired elements within that document's iframe.

user_178428860
Related