Создаёт спецификации Swagger/OpenAPI 2.0 и интерактивную документацию по API на Django REST Framework.
drf-yasg анализирует представления и сериализаторы Django REST Framework и формирует на их основе схему OpenAPI 2.0 (Swagger), поэтому документация API соответствует коду и не требует ручного обновления. Схему можно отдавать в формате JSON или YAML, а библиотека включает swagger-ui и ReDoc, чтобы просматривать сгенерированную документацию прямо в проекте.
Для настройки достаточно добавить приложение в INSTALLED_APPS и подключить представление схемы в urls.py. Поддерживаются вложенные сериализаторы, а на каждом этапе генерации спецификации доступны хуки для настройки. Кэширование встроено; кроме того, схему можно проверять с помощью swagger-spec-validator.
Проект поддерживает только OpenAPI 2.0. Для новых проектов, которым нужен OpenAPI 3.0, сопровождающие рекомендуют drf-spectacular; в README также отмечено, что поддержка версии 3.0 вряд ли появится в drf-yasg.
Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.
Инструмент с открытым исходным кодом для создания адаптивного трёхпанельного сайта со справочной документацией API на основе спецификаций OpenAPI, Swagger, AsyncAPI или GraphQL.
Java-библиотека, которая генерирует спецификации OpenAPI по аннотациям кода и REST API на JAX-RS и поддерживает OpenAPI 3.x.
Swagger UI отображает в браузере интерактивную документацию API на основе спецификации OpenAPI/Swagger.
Набор инструментов с открытым исходным кодом для OpenAPI/Swagger: интерактивная справка по API, API-клиент с приоритетом работы офлайн и интеграции со многими веб-фреймворками.
Инструмент для Go, который генерирует документацию API в формате Swagger 2.0 по аннотациям в комментариях к исходному коду.
Веб-фреймворк на Python для создания REST API с типами Python поверх Django, автоматической документацией OpenAPI и валидацией Pydantic.