encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-07-06 13:23:18 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fix : Updated documentation in tutorial 5 leading to error

Browse Source
This commit is contained in:
Ali hassan 2025-06-29 00:33:06 +05:00
parent e454758fb6
commit fc4c20078c
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/tutorial/5-relationships-and-hyperlinked-apis.md
View File

@ -94,6 +94,16 @@ Notice that we've also added a new `'highlight'` field. This field is of the sa
Because we've included format suffixed URLs such as `'.json'`, we also need to indicate on the `highlight` field that any format suffixed hyperlinks it returns should use the `'.html'` suffix. Because we've included format suffixed URLs such as `'.json'`, we also need to indicate on the `highlight` field that any format suffixed hyperlinks it returns should use the `'.html'` suffix.
**Important:**
When you are manually instantiating these serializers inside your views (e.g., in `SnippetDetail` or `SnippetList`), you **must** pass `context={'request': request}` so the serializer knows how to build absolute URLs.
For example, instead of:
serializer = SnippetSerializer(snippet)
you must write:
serializer = SnippetSerializer(snippet, context={'request': request})
## Making sure our URL patterns are named ## Making sure our URL patterns are named
If we're going to have a hyperlinked API, we need to make sure we name our URL patterns. Let's take a look at which URL patterns we need to name. If we're going to have a hyperlinked API, we need to make sure we name our URL patterns. Let's take a look at which URL patterns we need to name.