Есть ли в Django Rest Framework сторонние приложения для автоматического создания файла swagger.yaml?

Question

У меня есть большое количество конечных точек API, написанных на django-rest-framework и это продолжает увеличиваться и обновляться. Как я могу создавать и поддерживать документацию API, которая должна быть актуальной?

Моя текущая версия

1. Создайте swagger.yaml файл и как-то автоматически генерировать каждый раз, когда изменяется любая конечная точка.
2. Затем используйте этот файл в качестве входных данных для readme.io, ReDoc или других альтернатив, чтобы обеспечить визуализацию для внешних пользователей.

Если у вас есть опыт использования этого или любого другого подобного решения, пожалуйста, поделитесь, я действительно ценю это!

Answer 1

Да, вы можете взглянуть на drf-yasg:

Drf-Yasg Docs

Быстрый старт показывает, как создаются 4 конечные точки, включая ту, которая выводит файл swagger.yaml. Включив drf-yasg, вы можете перейти к:

HTTP: // локальный: 8000 / swagger.yaml

который затем позволит вам сохранить документацию на диск.