記錄Django Rest Framework API

Question

尋找django休息框架應用程序的自我描述api

我們正在使用Django 2和Django Rest Framework 3.7.3我們希望基於查看doc字符串或元數據來記錄api我已經嘗試過drf docs和drf auto docs並且似乎不支持我們的應用程序有人提到了pydocs ，但不要認為這會起作用我認為更糟糕的情況是使用Sphinx

我們想要一個理想情況下給出一個例子的api

示例請求：

GET /tests HTTP/1.1

響應示例：

HTTP/1.1 200 OK
Content-Type: application/json
[
    {
        "name": "test1",

    },
    {
        "name": "test2",

    }
]

狀態代碼：

200 OK – List of a tests.

Answer 1

您可以嘗試drf-yasg ，它支持生成redoc或swagger文檔。