Add middleware documentation #1706
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
Ruwann
approved these changes
May 30, 2023
docs/middleware.rst
Outdated
| **SwaggerUIMiddleware**, Adds a Swagger UI to your application | ||
| **RoutingMiddleware**, "Routes incoming requests to the right operation defined in the | ||
| specification" | ||
| **SecurityMiddleware**, Checks incoming requests against the security defined in the spec |
There was a problem hiding this comment.
nit: inconsistency between "specification" in RoutingMiddleware and "spec" here
docs/middleware.rst
Outdated
| **RoutingMiddleware**, "Routes incoming requests to the right operation defined in the | ||
| specification" | ||
| **SecurityMiddleware**, Checks incoming requests against the security defined in the spec | ||
| **RequestValidationMiddleware**, validates the incoming requests against the spec |
docs/middleware.rst
Outdated
| The :code:`add_middleware` method takes a :code:`position` argument to define where in the | ||
| middleware stack it should be inserted, which should be an instance of the | ||
| :class:`~connexion.middleware.MiddlewarePosition` Enum. The positions below are ordered from | ||
| first to last. Note that responses hit the middlewares in reversed order. |
There was a problem hiding this comment.
What do you mean with "first to last"? 😅
I find it easier to talk about "outer" and "inner" when it comes to middleware, but might be personal?
| If you need more flexibility, or want to modify or delete any of the default middlewares, you can | ||
| also pass in a customized middleware stack when instantiating your application. | ||
|
|
||
| For example, if you would like to remove the :class:`SecurityMiddleware` since you are handling |
There was a problem hiding this comment.
A remove_middleware() method or exclude argument could be useful indeed 😛
17 tasks
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.
Contributes towards #1531
This PR adds a documentation page on middleware.