Документирование проекта django (django 2 + drf + drf-access-policy) - PullRequest
0 голосов
/ 17 февраля 2020

Я документирую django проект, который использует DRF. Я уже сгенерировал динамическую c схему API с использованием openapi и redo c. Очень крутые решения

Тем не менее, я пропускаю часть разрешений во всем этом

У меня много разрешений (access_classes) в наборах представлений и некоторых функциях. Знаете ли вы какое-либо решение для включения разрешения в схему или в документацию в целом?

В дальнейшем, как вы документируете разрешения в API в целом?

У меня уже есть идея: включить разрешения в пользовательское описание в схему, но оно все еще грязное

Спасибо. Хосе .-

PS: извините за бедный английский sh

1 Ответ

1 голос
/ 17 февраля 2020

DRF исключает использование пакета coreapi, однако в настоящее время в этом решении нет простого способа добавить схемы безопасности в вашу документацию.

Однако существует альтернатива https://drf-yasg.readthedocs.io/en/stable/ этот инструмент претендует на поддержку извлечения этих значений (но я лично еще не использовал его для этого).

...