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

Merge pull request #1023 from jsummerfield/patch-5

Browse Source 
Fix typos in routers.md
This commit is contained in:
Stephan Groß 2013-08-03 02:38:25 -07:00
commit b52beb0734
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api-guide/routers.md
View File

@ -38,7 +38,7 @@ The example above would generate the following URL patterns:
### Extra link and actions ### Extra link and actions
Any methods on the viewset decorated with `@link` or `@action` will also be routed. Any methods on the viewset decorated with `@link` or `@action` will also be routed.
For example, a given method like this on the `UserViewSet` class: For example, given a method like this on the `UserViewSet` class:
@action(permission_classes=[IsAdminOrIsSelf]) @action(permission_classes=[IsAdminOrIsSelf])
def set_password(self, request, pk=None): def set_password(self, request, pk=None):
@ -66,7 +66,7 @@ This router includes routes for the standard set of `list`, `create`, `retrieve`
<tr><td>POST</td><td>@action decorated method</td></tr> <tr><td>POST</td><td>@action decorated method</td></tr>
</table> </table>
By default the URLs created by `SimpleRouter` are appending with a trailing slash. By default the URLs created by `SimpleRouter` are appended with a trailing slash.
This behavior can be modified by setting the `trailing_slash` argument to `False` when instantiating the router. For example: This behavior can be modified by setting the `trailing_slash` argument to `False` when instantiating the router. For example:
router = SimpleRouter(trailing_slash=False) router = SimpleRouter(trailing_slash=False)
@ -90,7 +90,7 @@ This router is similar to `SimpleRouter` as above, but additionally includes a d
<tr><td>POST</td><td>@action decorated method</td></tr> <tr><td>POST</td><td>@action decorated method</td></tr>
</table> </table>
As with `SimpleRouter` the trailing slashs on the URL routes can be removed by setting the `trailing_slash` argument to `False` when instantiating the router. As with `SimpleRouter` the trailing slashes on the URL routes can be removed by setting the `trailing_slash` argument to `False` when instantiating the router.
router = DefaultRouter(trailing_slash=False) router = DefaultRouter(trailing_slash=False)
@ -139,7 +139,7 @@ The `SimpleRouter` class provides another example of setting the `.routes` attri
## Advanced custom routers ## Advanced custom routers
If you want to provide totally custom behavior, you can override `BaseRouter` and override the `get_urls(self)` method. The method should insect the registered viewsets and return a list of URL patterns. The registered prefix, viewset and basename tuples may be inspected by accessing the `self.registry` attribute. If you want to provide totally custom behavior, you can override `BaseRouter` and override the `get_urls(self)` method. The method should inspect the registered viewsets and return a list of URL patterns. The registered prefix, viewset and basename tuples may be inspected by accessing the `self.registry` attribute.
You may also want to override the `get_default_base_name(self, viewset)` method, or else always explicitly set the `base_name` argument when registering your viewsets with the router. You may also want to override the `get_default_base_name(self, viewset)` method, or else always explicitly set the `base_name` argument when registering your viewsets with the router.