-
-
Notifications
You must be signed in to change notification settings - Fork 7.1k
Clarify APIView.dispatch request lifecycle in docstring #9884
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sai09111995
wants to merge
4
commits into
encode:main
Choose a base branch
from
sai09111995:improve-apiview-dispatch-docstring
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
1148fea
Improve clarity in APIView documentation
sai09111995 abf9030
Clarify APIView.dispatch request lifecycle in docstring
sai09111995 aeecdc8
Merge branch 'main' into improve-apiview-dispatch-docstring
auvipy 7b980ef
Merge branch 'main' into improve-apiview-dispatch-docstring
auvipy File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,7 +10,8 @@ source: | |
| > | ||
| > — [Reinout van Rees][cite] | ||
|
|
||
| REST framework provides an `APIView` class, which subclasses Django's `View` class. | ||
| REST framework provides an `APIView` class, which subclasses Django’s base `View` class. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe "inherits" ? |
||
|
|
||
|
|
||
| `APIView` classes are different from regular `View` classes in the following ways: | ||
|
|
||
|
|
@@ -19,7 +20,9 @@ REST framework provides an `APIView` class, which subclasses Django's `View` cla | |
| * Any `APIException` exceptions will be caught and mediated into appropriate responses. | ||
| * Incoming requests will be authenticated and appropriate permission and/or throttle checks will be run before dispatching the request to the handler method. | ||
|
|
||
| Using the `APIView` class is pretty much the same as using a regular `View` class, as usual, the incoming request is dispatched to an appropriate handler method such as `.get()` or `.post()`. Additionally, a number of attributes may be set on the class that control various aspects of the API policy. | ||
| Using the `APIView` class is very similar to using a regular Django `View` class. | ||
| As usual, the incoming request is dispatched to an appropriate handler method such as `.get()` or `.post()`. | ||
|
|
||
|
|
||
| For example: | ||
|
|
||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes in this file were rejected in #9882 please don't submit them again