django-rest-framework - 如何在 ViewSet 文档字符串中明确记录可能的 REST 操作？

Question

DRF docs提到这个:

Note that when using viewsets the basic docstring is used for all generated views. To provide descriptions for each view, such as for the the list and retrieve views, use docstring sections as described in Schemas as documentation: Examples.

但是链接不好，类似链接， https://www.django-rest-framework.org/api-guide/schemas/ ，没有提到这些“部分”。

我如何在我的单个 Viewset 中清楚地记录我不同的可能的 REST 操作，当它组成时，

class ViewSet(mixins.ListModelMixin,                                            
              mixins.RetrieveModelMixin,                                        
              mixins.CreateModelMixin,                                          
              mixins.UpdateModelMixin,                                        
              ):       

Answer 1

在花了很长时间追踪这个之后，我从谷歌来到这里。确实有一种特殊的文档字符串格式来记录 ViewSet 的各个方法。

相关示例必须在某个时候从文档中删除，但我能够在源代码中找到它。它由函数 get_description 处理在 https://github.com/encode/django-rest-framework/blob/master/rest_framework/schemas/coreapi.py

文档字符串格式基于操作名称(如果定义了 view.action):

"""
General ViewSet description

list: List somethings

retrieve: Retrieve something

update: Update something

create: Create something

partial_update: Patch something

destroy: Delete something
"""

如果 view.action 未定义，则回退到方法名称: get , put , patch , delete .

每个新部分都以小写的 HTTP 方法名称开头，后跟冒号。