记录Django Rest Framework API

Question

寻找Django Rest Framework应用程序的自我描述api

我们正在使用Django 2和Django Rest Framework 3.7.3 我们正在根据查看文档字符串或元数据来记录api 我尝试了drf docs和drf auto docs，但似乎不支持我们的应用 有人提到pydocs，但认为这行不通 我认为最糟糕的情况是使用Sphinx

我们想要一个理想地提供示例的api

示例请求：

GET / tests HTTP / 1.1

示例响应：

HTTP / 1.1 200确定 内容类型：application / json [     {         “ name”：“ test1”，

},
{
    "name": "test2",

}

]

状态码：

200 OK – List of a tests.

Answer 1

您可以尝试drf-yasg，它支持生成redoc或swagger文档。