Упрощение файлов OpenAPI с помощью OpenAPI Trimmer

Управление большими файлами OpenAPI может быть затруднительным, особенно если вам нужна лишь небольшая часть API для конкретных задач. Вот тут-то и пригодится OpenAPI Trimmer. Это легкий инструмент, предназначенный для сокращения файлов OpenAPI и включения только тех конечных точек и объектов передачи данных (DTO), которые вам интересны.

Как это работает?

Предположим, вы работаете с большим файлом OpenAPI, но вам нужны только конечные точки, связанные с API цитат. Вы можете легко извлечь только эти конечные точки и удалить ненужные DTO с помощью одной команды:

openapi-trimmer -i openapi.yaml \
  -p /v1/quotes,/v1/users \
  -ec CompanyConfigDto,UpdateCompanyConfigDto

Эта команда:

• -i openapi.yaml: используйте существующий YAML-файл OpenAPI в качестве входных данных.
• -p /v1/quotes,/v1/users: сохранить только конечные точки, начинающиеся с /v1/quotes и /v1/users.
• -ec CompanyConfigDto,UpdateCompanyConfigDto: исключите определенные компоненты, в данном случае CompanyConfigDto и UpdateCompanyConfigDto.

Обрезанное определение API будет сохранено как openapi-trimmer.yaml.

Валидация

Чтобы обеспечить целостность обрезанного файла OpenAPI, проверьте его с помощью:

swagger-cli validate ./openapi-trimmer.yaml

Этот шаг помогает выявить любые проблемы перед развертыванием или публикацией обрезанного файла API.

Установка

Вы можете установить OpenAPI Trimmer прямо из PyPi:

pip install openapi-trimmer

Для получения более подробной информации и последних обновлений посетите страницу OpenAPI Trimmer PyPi.

Репозиторий GitHub: OpenAPI Trimmer на GitHub.

Параметры командной строки

Триммер OpenAPI предлагает несколько вариантов настройки его работы:

• -h, --help: показать справочную информацию.
• -v, --version: показать номер версии.
• -i INPUT, --input INPUT: укажите входной файл YAML (обязательно).
• -o OUTPUT, --output OUTPUT: определить имя выходного файла (необязательно; по умолчанию к входному файлу добавляется '-обрезанный').
• -p ПРЕФИКСЫ, --prefixes ПРЕФИКСЫ: перечислить пути, которые необходимо сохранить в выходных данных (через запятую).
• -ec EXCLUDE_COMPONENTS, --exclude-compents EXCLUDE_COMPONENTS: перечислить исключаемые компоненты (через запятую).

Заключение

OpenAPI Trimmer — это незаменимый инструмент для разработчиков, желающих оптимизировать свои файлы OpenAPI, сделав их более управляемыми и адаптированными к конкретным потребностям. Готовите ли вы документацию по API или упрощаете API для внутреннего использования, OpenAPI Trimmer экономит ваше время и усилия, концентрируясь только на том, что для вас наиболее важно.