Add Swagger UI persistAuthorization configuration parameter #3443
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I think the PR #2568 is more generic to give any parameters to swagger UI. |
|
@RayBB |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 developing APIs that requires authentication using Swagger UI, if you reload the browser window of Swagger UI to reflect a change in the code, the authentication is lost and you have to log in again, which is troublesome.
Swagger UI has a
persistAuthorizationparameter that, if enabled, will persist the authentication and keep you logged in even if you reload or close the browser.Swagger Documentation
In this PR, an argument
swagger_ui_persist_authis added toFastAPIconstructor to set thepersistAuthorizationparameter. The default value is False, but setting this argument to True will also set thepersistAuthorizationparameter of Swagger UI to true.