Dynamic OpenAPI (Swagger/ReDoc) documents based on route prefix

First Check

• I added a very descriptive title to this issue.
• I used the GitHub search to find a similar issue and didn’t find it.
• I searched the FastAPI documentation, with the integrated search.
• I already searched in Google “How to X in FastAPI” and didn’t find any information.
• I already read and followed all the tutorial in the docs and didn’t find an answer.
• I already checked if it is not related to FastAPI but to Pydantic.
• I already checked if it is not related to FastAPI but to Swagger UI.
• I already checked if it is not related to FastAPI but to ReDoc.

Commit to Help

• I commit to help with one of those options 👆

Example Code

from fastapi import FastAPI

prefix = "v1" # But it could be v2, v3, and so on.

app = FastAPI(
        title="Content Manager",
        openapi_url=f"{prefix}/docs/openapi.json",
        docs_url=f"/{prefix}/docs/",
        redoc_url=f"/{prefix}/docs/redoc",
    )

Description

So I’m writing a API that’s surely going to scale through versioning of my routes. Since FastAPI offers the OpenAPI integration so beautifuly, I wondered if my prefix versions could show only the document of the “route prefix” version.

I’ve tried to instantiate dynamically as inputted, but as the prefix is a fixed variable, it could not get it.

Has anybody achieved some thing sort of equal to what I’m wanting?

Operating System

macOS

Operating System Details

No response

FastAPI Version

0.68.0

Python Version

3.9.5

Additional Context

No response

[DevLucca]

Oh! That’s nice @Kludex! That’s perfect btw!

Thanks for the help guys!

[DevLucca]

Hi @dust63! I’ve created a good way using @Kludex method. Have a look here