diff options
| author | Tom Christie | 2012-10-30 14:32:31 +0000 |
|---|---|---|
| committer | Tom Christie | 2012-10-30 14:32:31 +0000 |
| commit | 9b30dab4f772f67a626e176dc4fae0a3ef9c2c81 (patch) | |
| tree | ca138abf4792f58ffa28684f784f201ee1eef6d7 /docs/howto/reverse.rst | |
| parent | 7e5b1501b5cede61a9391fb1a751d2ebcdb37031 (diff) | |
| parent | 4e7805cb24d73e7f706318b5e5a27e3f9ba39d14 (diff) | |
| download | django-rest-framework-9b30dab4f772f67a626e176dc4fae0a3ef9c2c81.tar.bz2 | |
Merge branch 'restframework2' into rest-framework-2-merge2.0.0
Conflicts:
.gitignore
.travis.yml
AUTHORS
README.rst
djangorestframework/mixins.py
djangorestframework/renderers.py
djangorestframework/resources.py
djangorestframework/serializer.py
djangorestframework/templates/djangorestframework/base.html
djangorestframework/templates/djangorestframework/login.html
djangorestframework/templatetags/add_query_param.py
djangorestframework/tests/accept.py
djangorestframework/tests/authentication.py
djangorestframework/tests/content.py
djangorestframework/tests/reverse.py
djangorestframework/tests/serializer.py
djangorestframework/views.py
docs/examples.rst
docs/examples/blogpost.rst
docs/examples/modelviews.rst
docs/examples/objectstore.rst
docs/examples/permissions.rst
docs/examples/pygments.rst
docs/examples/views.rst
docs/howto/alternativeframeworks.rst
docs/howto/mixin.rst
docs/howto/reverse.rst
docs/howto/usingurllib2.rst
docs/index.rst
docs/topics/release-notes.md
examples/sandbox/views.py
rest_framework/__init__.py
rest_framework/compat.py
rest_framework/utils/breadcrumbs.py
setup.py
Diffstat (limited to 'docs/howto/reverse.rst')
| -rw-r--r-- | docs/howto/reverse.rst | 50 |
1 files changed, 0 insertions, 50 deletions
diff --git a/docs/howto/reverse.rst b/docs/howto/reverse.rst deleted file mode 100644 index 0a7af0e9..00000000 --- a/docs/howto/reverse.rst +++ /dev/null @@ -1,50 +0,0 @@ -Returning URIs from your Web APIs -================================= - -As a rule, it's probably better practice to return absolute URIs from you web -APIs, e.g. "http://example.com/foobar", rather than returning relative URIs, -e.g. "/foobar". - -The advantages of doing so are: - -* It's more explicit. -* It leaves less work for your API clients. -* There's no ambiguity about the meaning of the string when it's found in - representations such as JSON that do not have a native URI type. -* It allows us to easily do things like markup HTML representations - with hyperlinks. - -Django REST framework provides two utility functions to make it simpler to -return absolute URIs from your Web API. - -There's no requirement for you to use them, but if you do then the -self-describing API will be able to automatically hyperlink its output for you, -which makes browsing the API much easier. - -reverse(viewname, ..., request=None) -------------------------------- - -The `reverse` function has the same behavior as -`django.core.urlresolvers.reverse`_, except that it optionally takes a request -keyword argument, which it uses to return a fully qualified URL. - - from djangorestframework.reverse import reverse - from djangorestframework.views import View - - class MyView(View): - def get(self, request): - context = { - 'url': reverse('year-summary', args=[1945], request=request) - } - - return Response(context) - -reverse_lazy(viewname, ..., request=None) ------------------------------------- - -The `reverse_lazy` function has the same behavior as -`django.core.urlresolvers.reverse_lazy`_, except that it optionally takes a -request keyword argument, which it uses to return a fully qualified URL. - -.. _django.core.urlresolvers.reverse: https://docs.djangoproject.com/en/dev/topics/http/urls/#reverse -.. _django.core.urlresolvers.reverse_lazy: https://docs.djangoproject.com/en/dev/topics/http/urls/#reverse-lazy |
