Документирование Django Rest Framework API - PullRequest
0 голосов
/ 30 мая 2019

В поисках API с самоописанием для django rest framework

Мы используем Django 2 и Django Rest Framework 3.7.3. Мы рассчитываем документировать API, основываясь на строках документации или метаданных Я пробовал drf docs и drf auto docs и, похоже, не поддерживает наше приложение Кто-то упомянул pydocs, но не думаю, что это сработает Наш худший случай - использование Сфинкса, я думаю

мы хотели бы 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.

1 Ответ

0 голосов
/ 06 июня 2019

Вы можете попробовать drf-yasg , который поддерживает создание документации redoc или swagger.

...