Provide documentation in the middleware
module
#3070
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.
PR Type
Other/Documentation
PR Checklist
A changelog entry has been made for the appropriate packages.Overview
As explained in #3026, this provides documentation about middleware in the
middleware
module. I took the example and parts of the explanation from actix.rs/docs/middleware. I added a section on the traits and the order of middleware.Furthermore, I looked at the authors-guide.md and tried to include some sections from there. I'm still missing "Understanding Body Types", "Best Practices", "Error Propagation", and "When To (Not) Use Middleware". Should I include these in this PR?
Since the
middleware
section now contains an example, should the documentation forTransform
link to it and/or should the example there be removed/changed?Closes #3026