Allow setting fastapi root_path argument #2341
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When FastAPI is run behind a path-based proxy the swagger fails to render because it is not aware of the path the application root is on
E.g. If the app is hosted on
https://example.com/vllm-svc/
thenwith
root_path=None
it will look for openapi.json athttps://example.com/openapi.json
and fail with 404with
root_path="vllm-svc"
it will look for openapi.json athttps://example.com/vllm-svc/openapi.json
which works correctlyThis change only affects the swagger at
/docs
See: https://fastapi.tiangolo.com/advanced/behind-a-proxy/#proxy-with-a-stripped-path-prefix