django restframework : add extra method
description
- django restframework viewset へ, 独自 path(method) を追加
how
- viewset class へ独自 method を追加
- path は自動生成される
code例
api/views.py
from rest_framework import viewsets
from rest_framework.response import Response
from rest_framework.decorators import action
from api.models import User
from .serializers import UserSerializer
class UserViewSet(viewsets.ModelViewSet):
queryset = User.objects.all().select_related()
serializer_class = UserSerializer
@action(methods=['post'], detail=True)
def set_password(self, request, pk):
'''
指定userへ passwordを設定する
'''
action設定
-
methods
- post, get, put... などの指定
- 複数指定可能
-
detail
- True の場合, 以下 path となる
- POST : /api/users/{id}/set_password/
- False
- POST : /api/users/set_password/
参考
- viewset class へ独自 method を追加
- path は自動生成される
code例
api/views.py
from rest_framework import viewsets
from rest_framework.response import Response
from rest_framework.decorators import action
from api.models import User
from .serializers import UserSerializer
class UserViewSet(viewsets.ModelViewSet):
queryset = User.objects.all().select_related()
serializer_class = UserSerializer
@action(methods=['post'], detail=True)
def set_password(self, request, pk):
'''
指定userへ passwordを設定する
'''
action設定
-
methods
- post, get, put... などの指定
- 複数指定可能
-
detail
- True の場合, 以下 path となる
- POST : /api/users/{id}/set_password/
- False
- POST : /api/users/set_password/
参考
api/views.py
from rest_framework import viewsets
from rest_framework.response import Response
from rest_framework.decorators import action
from api.models import User
from .serializers import UserSerializer
class UserViewSet(viewsets.ModelViewSet):
queryset = User.objects.all().select_related()
serializer_class = UserSerializer
@action(methods=['post'], detail=True)
def set_password(self, request, pk):
'''
指定userへ passwordを設定する
'''
-
methods
- post, get, put... などの指定
- 複数指定可能
-
detail
- True の場合, 以下 path となる
- POST : /api/users/{id}/set_password/
- False
- POST : /api/users/set_password/
- True の場合, 以下 path となる
参考
Author And Source
この問題について(django restframework : add extra method), 我々は、より多くの情報をここで見つけました https://qiita.com/Satoshi_Numasawa/items/0fe45c26ebf0b5a4d461著者帰属：元の著者の情報は、元のURLに含まれています。著作権は原作者に属する。
Content is automatically searched and collected through network algorithms . If there is a violation . Please contact us . We will adjust (correct author information ,or delete content ) as soon as possible .