python - 如何使用 Django REST Swagger 记录 pk 参数(或其他路径参数)？

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 文档字符串中添加 pk 参数，我会得到一个重复项。

Answer 1

pk 参数(或任何其他路径参数)可以使用 YAML 文档字符串进行记录，如 documentation of Django REST Swagger 中所述。 。属性列表可以引用 Swagger documentation .

请注意，您必须为路径参数指定paramType: path。为了避免在 api 文档中出现重复项，您可以按照 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
    """