django restframework : add extra method

• 以下記事を試行済みの想定.
  • https://qiita.com/Satoshi_Numasawa/items/53c6de8816de53e92851

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/

参考