Comments 3
У меня крайнее отвращение к этим гигантским декораторам над методами и классами.
Благо в этой же библиотеке есть возможность навесить декоратор без прямого исправления кода. Я бы это обязательно отметил в посте.
https://drf-spectacular.readthedocs.io/en/latest/customization.html#step-5-extensions
Согласен насчёт гигантских декораторов, обязательно изучу решение с extensions и постараюсь дополнить статью.
В текущем проекте проблему обошли с помощью регионов. По крайней мере в PyCharm можно настроить их отображение.
Весь код документации находится вот в такой конструкции:# region api_documentation
@extend_schema
@extend_schema_view
# endregion
По умолчанию всегда скрыто и находится под рукой рядом с view. Место не ест, сложнее забыть внести изменения после изменений кода, нагляднее в git, сразу видно что и где поменялось.
Хорошая статья! Пару предложений:
Мне еще удобно добавлять https://github.com/ghazi-git/drf-standardized-errors либу, плюс там есть интеграция в spectacular.
Плюс сюда в статью про мультисхемы можно че нить добавить, частый кейс по разделению апи по доступам (имхо конечно, но тема интересная) :)
Автоматическая документация API Django Rest Framework с помощью DRF Spectacular