Srmrlt
commented
9 months ago Обновление Документации OpenAPI
Описание изменений
- Переход с OpenAPI v2 на OpenAPI v3:
- Обновлённая версия более современна и позволяет избежать скорого прекращения поддержки библиотеки под Django для старой версии.
Доступность Документации
- Новая документация доступна по ссылкам:
api/swagger/api/redoc/
- Старая документация пока доступна по прежним адресам, но планируется её удаление.
Выполненные Действия
- Добавление описаний кастомных функций:
- Краткое описание для улучшения понимания функций.
- Удаление некорректных описаний функций:
- Исключено автоматическое подтягивание описаний из комментариев в коде.
- Добавление тегов к функциям:
- Теги для удобной группировки функций по функционалу.
- Редактирование полей запроса (request) и ответа (response):
- Изменения для ряда методов для повышения точности и понятности документации.
Что необходимо сделать
- Завершить редактирование полей запроса и ответа:
- Для некоторых методов требуется дополнительная работа для выявления необходимых параметров, поскольку функционирование методов нарушено.
Проблема: если посмотреть доку на, скажем, "обновление картинки", то дока подтянет все поля модели. Это связано, возможно, с тем, что мы юзам модельный сериализатор, он тупо оттуда все поля вытягивает. Вот этот момент нужно будет пофиксить на всех эндпоинтах - чтобы везде отображались только те поля, которые нужны.