How to specify Token URL in swagger ui if you use multi OAuth2PasswordBearer

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

admin_oauth2_schema = OAuth2PasswordBearer(
    tokenUrl=path.join(settings.ROOT_PATH + "/auth/admin-token")
)
candidate_oauth2_schema = OAuth2PasswordBearer(
    tokenUrl=path.join(settings.ROOT_PATH, "/auth/candidate-token")
)

Description

In my app I have two token urls for different user. So how can I specify one of them in swagger ui? Currently, swagger ui will use one of the token url based on the last oauth Depends you used in your code.

For example in my last router file I use depends candidate_oauth2_schema than the token url in swagger ui will become /auth/candidate-token but if I add another API below which uses depends admin_oauth2_schema then the token url will change to “/auth/admin-token”.

Operating System

Windows

Operating System Details

No response

FastAPI Version

0.70.1

Python Version

3.9.0

Additional Context

No response

[Dartt0n]

I have found the solution. You can specify different scheme_name for your OAuth2PasswordBearers.

Example:

admin_oauth2_schema = OAuth2PasswordBearer(
    tokenUrl="/api/auth/admin-token",
    scheme_name="admin_oauth2_schema"
)
candidate_oauth2_schema = OAuth2PasswordBearer(
    tokenUrl="/api/auth/candidate-token",
    scheme_name="candidate_oauth2_schema"
)

This way, Swagger UI will be able to different these two OAuth2PasswordBearers and will provide you useful UI to handle multiple oauth2 schemes.

[jiaulislam]

I have found the solution. You can specify different scheme_name for your OAuth2PasswordBearers.

Example:

admin_oauth2_schema = OAuth2PasswordBearer(
    tokenUrl="/api/auth/admin-token",
    scheme_name="admin_oauth2_schema"
)
candidate_oauth2_schema = OAuth2PasswordBearer(
    tokenUrl="/api/auth/candidate-token",
    scheme_name="candidate_oauth2_schema"
)

This way, Swagger UI will be able to different these two OAuth2PasswordBearers and will provide you useful UI to handle multiple oauth2 schemes.

Thanks 👍🏻 Was scratching my head for hours lol.