Extract Swagger UI functionality into middleware #1496
Merged
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
RobbeSneyders
force-pushed
the
feature/swagger-ui-middleware
branch
2 times, most recently
from
9222986 to
2980818
Compare
RobbeSneyders
force-pushed
the
feature/sync-async-security
branch
from
d286806 to
7b3f883
Compare
RobbeSneyders
force-pushed
the
feature/swagger-ui-middleware
branch
from
2980818 to
db12393
Compare
RobbeSneyders
commented
Mar 18, 2022
RobbeSneyders
force-pushed
the
feature/swagger-ui-middleware
branch
from
c5db83d to
2de9894
Compare
This was referenced Mar 20, 2022
Closed
RobbeSneyders
force-pushed
the
feature/swagger-ui-middleware
branch
from
2de9894 to
5afdf1b
Compare
RobbeSneyders
force-pushed
the
feature/swagger-ui-middleware
branch
from
5afdf1b to
f67a8dd
Compare
Co-authored-by: Wojciech Paciorek <[email protected]>
RobbeSneyders
force-pushed
the
feature/swagger-ui-middleware
branch
from
f67a8dd to
bbeb817
Compare
|
This one is ready for review @Ruwann |
Pull Request Test Coverage Report for Build 2144275390
💛 - Coveralls |
Ruwann
approved these changes
Apr 10, 2022
| @@ -32,7 +32,83 @@ def __init__(cls, name, bases, attrs): | |||
| cls._set_jsonifier() | |||
|
|
|||
|
|
|||
| class AbstractAPI(metaclass=AbstractAPIMeta): | |||
| class AbstractSpecAPI(metaclass=AbstractAPIMeta): | |||
There was a problem hiding this comment.
Can you add a docstring for clarity on what the purpose of this class is?
There was a problem hiding this comment.
Done.
We can probably remove some of these abstract API classes in the future, since they'll only be implemented for their respective middleware. For now I've kept them so it's clear which functionality is extracted from the AbstractAPI class.
RobbeSneyders
force-pushed
the
feature/swagger-ui-middleware
branch
from
e05322a to
f535806
Compare
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.
Part of #1489
This PR extracts the Swagger UI functionality into a middleware.
The middleware is implemented with a starlette router on which the swagger ui endpoints are registered. For all other routes, the router acts ass a pass-through.