spectacular

Создание схемы для API соответствующую стандарту OpenAPI3

Важно

• Предупреждения служат индикатором того, где ваш API не может быть корректно разрешен. @extend_schema и @extend_schema_field — ваши лучшие помощники

• Спецификация должна быть корректной в любом случае

• Не забудьте настроить метаданные ваших API, такие как серверы, версия, URL, документация и так далее, в вашем файле SPECTACULAR_SETTINGS.»

Зачем нужна

Команда генерирует машинно-читаемое описание HTTP-API сервера в формате OpenAPI 3 (YAML или JSON). Полученную схему можно скормить генератору SDK, импортировать в Postman/Insomnia или использовать как контракт для интеграции

Типичные случаи применения:

• получение актуальной схемы API установленного сервера для интеграции внешней системы

• генерация клиентского SDK на нужном языке программирования

• импорт API в инструмент тестирования (Postman, Insomnia) для сценариев QA

• сверка контракта API между версиями сервера при обновлении

Синтаксис

rude spectacular [--format {openapi,openapi-json}] [--urlconf URLCONF] [--generator-class GENERATOR_CLASS] [--file FILE] [--fail-on-warn] [--validate] [--api-version API_3.0.1563] [--lang LANG] [--color] [--custom-settings CUSTOM_SETTINGS]

Параметры

Параметр	Описание
--format	Вариант генерации (openapi или openapi-json)
--urlconf	Ссылка на ваш URL-сайта
--generator-class	GENERATOR_CLASS
--file	Файл для экспорта
--fail-on-warn
--validate
--api-version	Версия API
--lang	LANG
--color
--custom-settings	CUSTOM_SETTINGS

Примеры

Служебная команда сервера обычно не применяется пользователем в Linux-консоли используется разработчиками для генерации схем API в приложении