web-dev-qa-db-fra.com

Django REST Framework - transmet un paramètre supplémentaire aux actions

J'utilise Django 2.0 et Django REST Framework

J'ai créé une méthode d'action pour supprimer un objet particulier de la base de données

contacts/views.py 

class ContactViewSet(viewsets.ModelViewSet):
    serializer_class = ContactSerializer
    permission_classes = (IsAuthenticated, AdminAuthenticationPermission,)

    # others actions goes here

    @action(methods=['delete'], detail=False, url_path='delete_phone/<phone_pk>/')
    def delete_phone(self, request, pk=None):
        contact = self.get_object()
        print(contact)
        print(pk)
        print(self.kwargs['phone_pk'])
        return Response({'status': 'success'})

apps/urls.py 

router.register(r'contacts', ContactViewSet, 'contacts')

api_urlpatterns = [
    path('', include(router.urls)),
]

Mais quand j'accède 

DELETE: http://url/api/contacts/delete_phone/1/

Il donne l'erreur page not found.

Dans la page d'erreur, il y a une liste dans motifs d'url essayés 

api/ ^contacts/delete_phone/<phone_pk>//$ [name='contacts-delete-phone']
api/ ^contacts/delete_phone/<phone_pk>\.(?P<format>[a-z0-9]+)/?$ [name='contacts-delete-phone']
djangodjango-rest-framework
5
Anuj TBE

Résolu le problème en utilisant drf-nested-routers

Pour ceux qui en ont besoin, installez le plugin et configurez urls.py

from rest_framework_nested import routers

router = routers.SimpleRouter()
router.register(r'contacts', ContactViewSet, 'contacts')
contact_router = routers.NestedSimpleRouter(router, r'contacts', lookup='contact')
contact_router.register(r'phone_number', ContactPhoneNumberViewSet, base_name='contact-phone-numbers')

api_urlpatterns = [
    path('', include(router.urls)),
    path('', include(contact_router.urls))
]
2
Anuj TBE

Si vous ne pouvez pas/ne voulez pas/n’importe quelle installation drf-nested-routers, vous pouvez obtenir le même résultat en:

@action(detail=True,
        methods=['delete'],
        url_path='contacts/(?P<phone_pk>[^/.]+)')
def delete_phone(self, request, phone_pk, pk=None):
    contact = self.get_object()
    phone = get_object_or_404(contact.phone_qs, pk=phone_pk)
    phone.delete()
    return Response(.., status=status.HTTP_204_NO_CONTENT)

L'astuce consiste à mettre l'expression rationnelle dans le paramètre url_path du décorateur et à la transmettre à la méthode décorée (évitez d'utiliser juste pk, sinon il se heurtera au premier pk

Testé avec:

Django==2.0.10
djangorestframework==3.9.0
2
diegueus9
@action(methods=['delete'], detail=False)
def delete_phone(self, request, pk=None):
    contact = get_object_or_404(self.get_queryset(), pk=pk)
    contact.delete()
    return Response({'status': 'success'})

ça devrait marcher.

0
Sumeet Kumar