Herramientas de usuario
fw:djangorest
Diferencias
Muestra las diferencias entre dos versiones de la página.
| Ambos lados, revisión anterior Revisión previa Próxima revisión | Revisión previa | ||
|
fw:djangorest [2014/06/02 18:31] alfred [Others] |
fw:djangorest [2020/05/09 09:25] (actual) |
||
|---|---|---|---|
| Línea 411: | Línea 411: | ||
| You can code your own parse inheriting from ''BaseParser''. There also are other third party packages with their own parsers ''MessagePack'', ''CamelCaseJSON''... | You can code your own parse inheriting from ''BaseParser''. There also are other third party packages with their own parsers ''MessagePack'', ''CamelCaseJSON''... | ||
| + | |||
| + | ==== Filtering works? ==== | ||
| + | To restrict the returned queryset you can filter... | ||
| + | === Against the current user === | ||
| + | <code python> | ||
| + | class PurchaseList(generics.ListAPIView) | ||
| + | serializer_class = PurchaseSerializer | ||
| + | def get_queryset(self): | ||
| + | user = self.request.user | ||
| + | return Purchase.objects.filter(purchaser=user) | ||
| + | </code> | ||
| + | |||
| + | === Against the url === | ||
| + | <code python> | ||
| + | url('^purchases/(?P<username>.+)/$', PurchaseList.as_view()), | ||
| + | ... | ||
| + | class PurchaseList(generics.ListAPIView) | ||
| + | serializer_class = PurchaseSerializer | ||
| + | def get_queryset(self): | ||
| + | username = self.kwargs['username'] | ||
| + | return Purchase.objects.filter(purchaser__username=username) | ||
| + | </code> | ||
| + | |||
| + | === Against query parameters === | ||
| + | <code python> | ||
| + | class PurchaseList(generics.ListAPIView) | ||
| + | serializer_class = PurchaseSerializer | ||
| + | def get_queryset(self): | ||
| + | queryset = Purchase.objects.all() | ||
| + | username = self.request.QUERY_PARAMS.get('username', None) | ||
| + | if username is not None: | ||
| + | queryset = queryset.filter(purchaser__username=username) | ||
| + | return queryset | ||
| + | </code> | ||
| + | |||
| + | === Others === | ||
| + | * [[http://www.django-rest-framework.org/api-guide/filtering]] | ||
| + | Django REST Framework provides several ways to return a queryset only defining order or fields. Also you can define your own filter classes. | ||
| + | |||
| + | ==== Pagination works? ==== | ||
| ==== Others ==== | ==== Others ==== | ||
| Línea 416: | Línea 456: | ||
| It's how to return the Response with a concrete format indicated by the url: [[http://www.django-rest-framework.org/api-guide/format-suffixes]]. | It's how to return the Response with a concrete format indicated by the url: [[http://www.django-rest-framework.org/api-guide/format-suffixes]]. | ||
| === Return URLs === | === Return URLs === | ||
| + | * [[http://www.django-rest-framework.org/api-guide/reverse]] | ||
| When returning URLs to other resources it's better to return the absolute url rather than the relative. Even if it was an identifier; if the string represents a resource, in REST it must be the resource absolute path. To do so in Django REST Framework you could use ''reverse'' and ''reverse_lazy'' functions. | When returning URLs to other resources it's better to return the absolute url rather than the relative. Even if it was an identifier; if the string represents a resource, in REST it must be the resource absolute path. To do so in Django REST Framework you could use ''reverse'' and ''reverse_lazy'' functions. | ||
| + | |||
| + | === Configure === | ||
| + | * [[http://www.django-rest-framework.org/api-guide/settings]] | ||
| + | You can configure features like default classes (renderers, parsers, authentications...), generic view settings (pagination, ordering...), el formato de las fechas... | ||
| ===== Authentication and permissions ===== | ===== Authentication and permissions ===== | ||
| ==== Authentication ==== | ==== Authentication ==== | ||
| Línea 479: | Línea 524: | ||
| Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b | Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b | ||
| </code> | </code> | ||
| - | The curl command line tool may be useful for testing token authenticated APIs. For example: | + | The curl command for obtain the token: |
| + | <code> | ||
| + | curl -X POST http://127.0.0.1:8000/api-token-auth/ -H "Content-type: application/json" -d '{"username": "alfred", "password": "test"}' | ||
| + | </code> | ||
| + | |||
| + | The curl command for testing token authenticated APIs. For example: | ||
| <code> | <code> | ||
| curl -X GET http://127.0.0.1:8000/api/example/ -H 'Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b' | curl -X GET http://127.0.0.1:8000/api/example/ -H 'Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b' | ||
| Línea 526: | Línea 576: | ||
| return (user, None) | return (user, None) | ||
| </code> | </code> | ||
| - | |||
| ==== Permissions ==== | ==== Permissions ==== | ||
| Permissions are defined as a list of permission classes. When a view is called a permission list classes is checked, if any of them fails an ''exceptions.PermissionDenied'' exception will be raised. \\ | Permissions are defined as a list of permission classes. When a view is called a permission list classes is checked, if any of them fails an ''exceptions.PermissionDenied'' exception will be raised. \\ | ||
fw/djangorest.1401733876.txt.gz · Última modificación: 2020/05/09 09:24 (editor externo)
Herramientas de la página
Excepto donde se indique lo contrario, el contenido de este wiki esta bajo la siguiente licencia: CC Attribution-Noncommercial-Share Alike 4.0 International
