js-openapi

@e22m4u/js-openapi

JavaScript модуль для создания OpenAPI Документа 3.1.2

Модуль автоматически проверяет структуру документа при определении компонентов и операций. В случае передачи некорректного или неизвестного ключевого слова генерируется исключение с указанием точного пути к ошибке.

Содержание

• Установка
• Базовый пример
• Работа с компонентами
• Содержимое запросов и ответов
• Группировка операций
• Константы
• Тесты
• Лицензия

Установка

Модуль поддерживает ESM и CommonJS стандарты.

ESM

CommonJS

Базовый пример

Создание экземпляра сборщика.

Определение операции.

Сборка документа в виде JavaScript объекта.

Формирование JSON документа (сериализация).

Работа с компонентами

Регистрация компонента схемы.

Регистрация компонента параметра.

Использование зарегистрированного имени компонента.

Содержимое запросов и ответов

Определение тела запроса операции.

Определение тела ответа операции.

Определение компонента схемы для следующего примера.

Определение содержания запроса и ответа с использованием ссылок.

Группировка операций

Создание группы операций с общим префиксом пути и тегом.

Создание вложенных групп для комбинирования операций.

Константы

Operation Method

Parameter Location

Parameter Style

Data type

Data format

Media type

Security Scheme Type

Api Key Location

Access mode

Тесты

Лицензия

MIT