maira-cli
MairaCLI - это инструмент для разработчиков, предназначенный для автоматической генерации документации Swagger для конечных точек, перехватывая запросы и ответы во время тестирования конечных точек API.
Перечислено в категориях:
Инструменты разработчикаКатегорииОткрытый исходный код
Описание
MairaCLI — это инструмент для разработчиков, предназначенный для автоматической генерации документации Swagger для API-эндпоинтов путем перехвата запросов и ответов во время тестирования.
Как использовать maira-cli?
Чтобы использовать MairaCLI, установите его через npm, запустите прокси-сервер в вашем бэкенд-проекте, настройте необходимые детали в файле config.json и делайте запросы к вашему бэкенду через прокси-сервер. После выполнения запросов сгенерируйте документацию, используя предоставленную команду.
Основные функции maira-cli:
1️⃣
Автоматически генерирует документацию Swagger для API-эндпоинтов
2️⃣
Перехватывает запросы и ответы для точной документации
3️⃣
Создает конфигурационные файлы для маршрутов проекта
4️⃣
Генерирует ссылки на предварительный просмотр документации
5️⃣
Поддерживает пользовательские заголовки аутентификации
Почему использовать maira-cli?
| # | Сценарий использования | Статус | |
|---|---|---|---|
| # 1 | Генерация документации API для бэкенд-проектов | ✅ | |
| # 2 | Тестирование API-эндпоинтов с одновременной документацией | ✅ | |
| # 3 | Создание документации Swagger для микросервисов | ✅ | |
Разработано maira-cli?
MairaCLI разработан сообществом участников на GitHub, целью которого является упрощение процесса документации API для разработчиков.