Question

有没有办法记录Django REST Framework自动生成的pk参数（通过扩展ViewSet）？

ViewSet中的示例函数：

class MyViewSet(viewsets.ViewSet):
    @detail_route(url_path='mypath')
    def myapi(self):
        """
            first_param -- Param 1
        """
        pass

如果我在YAML docstring中添加一个pk参数，我得到了一个副本。

Answer 1

pk 参数（或任何其他路径参数）可以使用YAML文档字符串进行记录，如documentation of Django REST Swagger中所述。对于属性列表，您可以参考Swagger documentation。

请注意，您必须为路径参数指定paramType: path。为避免重复出现在api-docs中，您可以按照here所述指定parameters_strategy: replace。

示例：

@detail_route(url_path='mypath')
def myapi(self, request, **kwargs):
    """
    Endpoint documentation.
    ---
        parameters_strategy: replace
        parameters:
            - name: pk
              description: "Primary Key"
              required: true
              type: string
              paramType: path
    """

如何使用Django REST Swagger记录pk参数（或其他路径参数）？

1 个答案: