Prism CLI
Prism — CLI для тестов по OpenAPI: клиент получает ответы из описания API, пока команда еще пишет серверную часть.
- 5 064 ★ репозитория
- Последний коммит
- Apache-2.0
Расширенный доступ
Почему такой уровень
- CLI запускает локальный HTTP-сервер и может загружать спецификацию по URL.
- В режиме прокси программа пересылает HTTP-запросы к указанному API, включая изменения, если их отправит клиент.
Установка
В терминале, через SkillFoxx CLI
npx skillfoxx add cli/prismОпределит агенты на машине, покажет уровень доступа и зафиксирует версию.
Другие способы установки
Доступ и проверки
Как мы проверяемРасширенный доступИнструмент запускает код или ходит в сеть, а внешние данные только читает.
- CLI запускает локальный HTTP-сервер и может загружать спецификацию по URL.
- В режиме прокси программа пересылает HTTP-запросы к указанному API, включая изменения, если их отправит клиент.
Это чужой код. Посмотрите файлы в репозитории перед установкой.
Что делает
Prism — CLI для запуска тестового HTTP-сервера по спецификации API. Разработчик передает документ OpenAPI или коллекцию Postman и получает адрес, к которому можно подключить клиент до готовности сервера. Такой тестовый сервер называют моком: он формирует ответы по описанию API и проверяет запросы. В режиме прокси, посредника между клиентом и сервером, Prism передает запросы существующему API и находит расхождения со спецификацией. Поэтому одну схему можно использовать сначала для разработки интерфейса, затем для поиска несовпадений между документацией и ответами сервиса.
Для кого. Фронтенд-разработчикам и тестировщикам, которые согласовали формат запросов и ответов API, но еще ждут готовую серверную часть.
Подходит, если
- Дизайнер API передал OpenAPI, и разработчик подключает интерфейс к моку.
- Тестировщик сравнивает ответы работающего сервиса с согласованной спецификацией.
- В CI команда запускает HTTP-сервер из того же контракта, что хранится рядом с тестами.
- Потребитель API проверяет допустимые запросы до доступа к рабочей системе.
Не подходит, если
- Команда ожидает, что мок сохранит созданные данные между запросами как полноценная база.
- Разработчик хочет автоматически восстановить OpenAPI по записанному HTTP-трафику.
- Продукту нужна рабочая бизнес-логика, отсутствующая в описании ответов.
Пример запроса к агенту
Запусти Prism по нашей OpenAPI локально и покажи доступные пути. Реальный API пока не вызывай и прокси не включай.Ограничения
Для локального CLI нужен Node.js; в разделе установки README указано требование 18.20.1 или новее. Сохранение данных мока между запросами остается незакрытым пунктом дорожной карты. Обучение по HTTP-трафику и создание спецификации из него тоже пока указаны как будущая возможность. По умолчанию сервер слушает localhost, поэтому в Docker он недоступен снаружи контейнера без явной настройки адреса привязки и публикации порта.
Как отключить. Остановите процесс `prism mock` или `prism proxy` и уберите запуск из CI. Верните клиенту адрес его обычного API; файл спецификации останется на диске.
Частые вопросы
Как запустить тестовый сервер?
После установки выполните `prism mock https://raw.githack.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml`. CLI выведет доступные URL; откройте один из них клиентом, затем подставьте свою спецификацию.
Почему адрес с basePath возвращает 404?
Prism не требует добавлять `basePath` к пути. В примере README работает `http://localhost:4010/hello`, а `/api/v1/hello` возвращает ошибку. Возьмите точный URL из вывода CLI.
Как проверить существующий API?
Режим `prism proxy` передает запросы работающему сервису и сообщает о расхождениях с OpenAPI. Выберите тестовое окружение, направьте клиент на прокси и сравните найденные ошибки с согласованным описанием API.
Почему контейнер запущен, но мок недоступен?
По умолчанию Prism привязан к localhost. README советует для Docker флаг `-h 0.0.0.0`; после настройки адреса также опубликуйте нужный порт контейнера.
Какие спецификации поддерживаются?
В README перечислены OpenAPI 2.0, 3.0, 3.1 и коллекции Postman. Перед запуском выберите файл соответствующего формата и используйте его как источник мока.
Обсуждение
Вопросов и отзывов пока нет.
Похожие
CLI-инструментыCLI генерирует API-тесты по схеме и дает агенту воспроизводимые ошибки ответов и последовательностей операций.
aimock, CLI тестовых API, проверяет локальные файлы с подготовленными ответами до запуска сервера и обращения к приложению.
MCP-сервер: агент шлет GET, POST, PUT, DELETE и PATCH на ваш REST API и получает код, заголовки и тело ответа
Интерактивный HTTP-клиент позволяет проверить запрос из браузера, изменить его параметры и изучить ответ в терминале.
CLI для тестирования и ред-тиминга LLM-приложений: сравнение моделей, автоматические проверки в CI и поиск уязвимостей
Официальный MCP-сервер Postman: рабочие пространства, коллекции, спецификации и окружения прямо из агента
Коротко о README
Автор разделяет локальный открытый сервер и размещенные варианты Stoplight. CLI работает самостоятельно или в CI. Примеры README отдельно показывают мок и прокси с проверкой контракта.