stoplightio/prism

Что это?

Ключевые возможности

• 01Создаёт mock HTTP-сервер на основе файлов OpenAPI v2, v3.0, v3.1 или Postman Collection.
• 02Проверяет запросы и ответы на соответствие спецификации API.
• 03Работает как прокси для проверки реального API и выявления расхождений с контрактом.
• 04Поддерживает согласование содержимого и проверку безопасности.
• 05Запускается из командной строки и может использоваться в непрерывной интеграции.

Сценарии использования

• Позволяет разработчикам фронтенда работать с API до реализации его бэкенда.
• Помогает во время тестирования проверять, что реальный API по-прежнему соответствует контракту OpenAPI.
• Позволяет запускать mock-зависимости API в CI-пайплайнах.
• Даёт возможность показать заинтересованным сторонам дизайн API с реалистичными примерами ответов.

Быстрый старт

1. 1

   Установите Prism CLI с помощью npm (требуется Node.js версии 18.20.1 или новее)

   npm install -g @stoplight/prism-cli
2. 2

   Запустите мок-сервер на основе документа OpenAPI

   prism mock https://raw.githack.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml
3. 3

   Или запустите прокси для проверки перед существующим API

   prism proxy examples/petstore.oas2.yaml https://petstore.swagger.io/v2

Что важно знать

• !Требуется Node.js версии 18.20.1 или новее; для Node 18.x необходима версия не ниже 18.16.

Темы

Частые вопросы

Что такое prism?

CLI и HTTP-сервер, который превращает файлы OpenAPI v2/v3 и Postman Collection в mock API с валидацией запросов и прокси для проверки соответствия. Prism — набор пакетов для мокирования API и тестирования контрактов. Получив документ OpenAPI v2, OpenAPI v3.x или Postman Collection, он запускает HTTP-сервер, который возвращает ответы, соответствующие спецификации. Благодаря этому команды фронтенда и клиентской разработки могут работать ещё до появления бэкенда.

prism можно использовать бесплатно? Какая у него лицензия?

prism распространяется с открытым исходным кодом под лицензией Apache-2.0. Перед использованием в коммерческих продуктах проверьте условия лицензии.

prism всё ещё поддерживается?

Активно поддерживается. Последний коммит в prism — 12 окт. 2026 г..

Для чего можно использовать prism?

Позволяет разработчикам фронтенда работать с API до реализации его бэкенда. Помогает во время тестирования проверять, что реальный API по-прежнему соответствует контракту OpenAPI. Позволяет запускать mock-зависимости API в CI-пайплайнах. Даёт возможность показать заинтересованным сторонам дизайн API с реалистичными примерами ответов.

Как установить prism?

Установите Prism CLI с помощью npm (требуется Node.js версии 18.20.1 или новее): npm install -g @stoplight/prism-cli Запустите мок-сервер на основе документа OpenAPI: prism mock https://raw.githack.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml Или запустите прокси для проверки перед существующим API: prism proxy examples/petstore.oas2.yaml https://petstore.swagger.io/v2

Где скачать prism?

Исходный код и инструкции по установке — на GitHub: https://github.com/stoplightio/prism