Как документировать схему ответа для документации Django REST Framework? - PullRequest
0 голосов
/ 06 июня 2018

Я документирую пользовательскую конечную точку, используя API документации по умолчанию DRF.Вывод конечной точки довольно сложный, и мне нужен красивый способ показать его разработчикам внешнего интерфейса в документации API.Текущее решение состоит в том, чтобы использовать строку документа метода, которая не так хороша.

Существует простой способ описания входных параметров с использованием schema, но я не могу найти примеры для описания схемы для вывода.

В официальной документации есть скриншот, показывающий, что это возможно (обратите внимание на response schema на рисунке), но, к сожалению, нет примера.

enter image description here

1 Ответ

0 голосов
/ 28 августа 2018

Я искал ту же функциональность, но кажется, что большая часть этого ответа автоматически генерируется с небольшим контролем над ним.Например, моя установка настаивала на том, что все мои POST должны возвращать 201 и не иметь возможности указывать тело настраиваемого ответа, просто какой-то объект, который, как он решил, создает этот POST.было очень легко начать и указать ответы , например: user_response = openapi.Response('response description', UserSerializer)

...