paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-24 16:43:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

rest: Add rest_path shortcut for path with rest_dispatch.

Browse Source 
Signed-off-by: Anders Kaseorg <anders@zulip.com>
This commit is contained in:
Anders Kaseorg
2020-09-21 21:04:45 -07:00
committed by Tim Abbott
parent 5297e4a30a
commit 0228acf0f5
6 changed files with 304 additions and 302 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/tutorials/life-of-a-request.md
View File

@@ -140,9 +140,9 @@ yields a response with this HTTP header:
We can see this reflected in [zproject/urls.py](https://github.com/zulip/zulip/blob/master/zproject/urls.py):
path('users', rest_dispatch,
{'GET': get_members_backend,
'PUT': create_user_backend}),
rest_path('users',
GET=get_members_backend,
PUT=create_user_backend),
In this way, the API is partially self-documenting.
@@ -176,11 +176,11 @@ the request, and then figure out which view to show from that.
In our example,
```
{'GET': get_members_backend,
'PUT': create_user_backend}
GET=get_members_backend,
PUT=create_user_backend
```
is supplied as an argument to `rest_dispatch`, along with the
are supplied as arguments to `rest_path`, along with the
[HTTPRequest](https://docs.djangoproject.com/en/1.8/ref/request-response/).
The request has the HTTP verb `PUT`, which `rest_dispatch` can use to
find the correct view to show: