4

私はdjango restフレームワークAPIアプリケーションを持っており、そのドキュメントを生成しています。ビューセットで api ビューを使用し、カスタム メソッドを使用しています。URLではルーターを使用しています。ドキュメントの生成には、DRF Docs を使用します。

私の見解：

class UserViewSet(viewsets.ModelViewSet):
    """View for user object.
    """
    ...

    @detail_route(methods=["post"])
    def set_password(self, request, pk=None):
       """View to set new password
       """
       ...

URL:

from django.conf.urls import url, include

from rest_framework.routers import DefaultRouter

from accounts.views import UserViewSet


__all__ = ["accounts_urlpatterns"]


accounts_router = DefaultRouter()
accounts_router.register(r'users', UserViewSet)


accounts_urlpatterns = [
   url(r'^accounts/', include(accounts_router.urls))
]

私のAPIドキュメントの結果: ここに画像の説明を入力

set_password メソッドのカスタム コメントが必要で、このメソッドには他のシリアライザーを使用するため、さまざまなフィールドを表示します。どうやってやるの？

4

0 に答える 0