encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-27 20:14:01 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: Correct some evaluation results and a httpie option in Tutorial1 (#9421)

Browse Source 
* Tutorial 1: Added --unsorted option to httpie calls to prevent automatic json key sorting

* Tutorial 1: Changed evaluation results accurate
This commit is contained in:
wkwkhautbois 2024-06-02 13:14:37 +09:00 committed by GitHub
parent 36d5c0e74f
commit fbdab09c77
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 37 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
docs/tutorial/1-serialization.md
View File

@ -150,7 +150,7 @@ At this point we've translated the model instance into Python native datatypes.
content = JSONRenderer().render(serializer.data) content = JSONRenderer().render(serializer.data)
content content
# b'{"id": 2, "title": "", "code": "print(\\"hello, world\\")\\n", "linenos": false, "language": "python", "style": "friendly"}' # b'{"id":2,"title":"","code":"print(\\"hello, world\\")\\n","linenos":false,"language":"python","style":"friendly"}'
Deserialization is similar. First we parse a stream into Python native datatypes... Deserialization is similar. First we parse a stream into Python native datatypes...
@ -165,7 +165,7 @@ Deserialization is similar. First we parse a stream into Python native datatype
serializer.is_valid() serializer.is_valid()
# True # True
serializer.validated_data serializer.validated_data
# OrderedDict([('title', ''), ('code', 'print("hello, world")\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]) # {'title': '', 'code': 'print("hello, world")', 'linenos': False, 'language': 'python', 'style': 'friendly'}
serializer.save() serializer.save()
# <Snippet: Snippet object> # <Snippet: Snippet object>
@ -175,7 +175,7 @@ We can also serialize querysets instead of model instances. To do so we simply
serializer = SnippetSerializer(Snippet.objects.all(), many=True) serializer = SnippetSerializer(Snippet.objects.all(), many=True)
serializer.data serializer.data
# [OrderedDict([('id', 1), ('title', ''), ('code', 'foo = "bar"\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('id', 2), ('title', ''), ('code', 'print("hello, world")\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('id', 3), ('title', ''), ('code', 'print("hello, world")'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])] # [{'id': 1, 'title': '', 'code': 'foo = "bar"\n', 'linenos': False, 'language': 'python', 'style': 'friendly'}, {'id': 2, 'title': '', 'code': 'print("hello, world")\n', 'linenos': False, 'language': 'python', 'style': 'friendly'}, {'id': 3, 'title': '', 'code': 'print("hello, world")', 'linenos': False, 'language': 'python', 'style': 'friendly'}]
## Using ModelSerializers ## Using ModelSerializers
@ -321,42 +321,50 @@ You can install httpie using pip:
Finally, we can get a list of all of the snippets: Finally, we can get a list of all of the snippets:
http http://127.0.0.1:8000/snippets/ http http://127.0.0.1:8000/snippets/ --unsorted
HTTP/1.1 200 OK HTTP/1.1 200 OK
... ...
[ [
{ {
"id": 1, "id": 1,
"title": "", "title": "",
"code": "foo = \"bar\"\n", "code": "foo = \"bar\"\n",
"linenos": false, "linenos": false,
"language": "python", "language": "python",
"style": "friendly" "style": "friendly"
}, },
{ {
"id": 2,
"title": "",
"code": "print(\"hello, world\")\n",
"linenos": false,
"language": "python",
"style": "friendly"
},
{
"id": 3,
"title": "",
"code": "print(\"hello, world\")",
"linenos": false,
"language": "python",
"style": "friendly"
}
]
Or we can get a particular snippet by referencing its id:
http http://127.0.0.1:8000/snippets/2/ --unsorted
HTTP/1.1 200 OK
...
{
"id": 2, "id": 2,
"title": "", "title": "",
"code": "print(\"hello, world\")\n", "code": "print(\"hello, world\")\n",
"linenos": false, "linenos": false,
"language": "python", "language": "python",
"style": "friendly" "style": "friendly"
}
]
Or we can get a particular snippet by referencing its id:
http http://127.0.0.1:8000/snippets/2/
HTTP/1.1 200 OK
...
{
"id": 2,
"title": "",
"code": "print(\"hello, world\")\n",
"linenos": false,
"language": "python",
"style": "friendly"
} }
Similarly, you can have the same json displayed by visiting these URLs in a web browser. Similarly, you can have the same json displayed by visiting these URLs in a web browser.