stoplightio/prism

어떤 프로젝트인가요?

핵심 기능

• 01OpenAPI v2, v3.0, v3.1 또는 Postman Collection 파일을 바탕으로 모의 HTTP 서버를 생성합니다.
• 02API 사양에 따라 요청과 응답을 검증합니다.
• 03실제 API 앞에서 검증 프록시로 실행해 계약 불일치를 찾아냅니다.
• 04콘텐츠 협상과 보안 검증을 지원합니다.
• 05명령줄에서 실행할 수 있으며 지속적 통합 환경에서도 사용할 수 있습니다.

활용 사례

• 백엔드가 구현되기 전에 프런트엔드 개발자가 API를 기반으로 작업하도록 합니다.
• 테스트 중 실제 API가 OpenAPI 계약과 계속 일치하는지 확인합니다.
• CI 파이프라인에서 모의 API 의존성을 실행합니다.
• 실제와 유사한 샘플 응답을 사용해 이해관계자에게 API 설계를 시연합니다.

빠른 시작

1. 1

   npm으로 Prism CLI를 설치합니다(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은(는) 무엇인가요?

OpenAPI v2/v3 및 Postman Collection 파일을 요청 검증과 검증 프록시를 지원하는 모의 API로 바꿔 주는 CLI 및 HTTP 서버입니다. Prism은 API 모킹과 계약 테스트를 위한 패키지 모음입니다. OpenAPI v2, OpenAPI v3.x 또는 Postman Collection 문서를 입력하면 사양에 맞는 응답을 반환하는 HTTP 서버를 시작하므로, 프런트엔드 팀과 클라이언트 팀은 백엔드가 준비되기 전에도 작업을 진행할 수 있습니다.

prism은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

prism은(는) Apache-2.0 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

prism은(는) 아직 유지보수되고 있나요?

활발히 유지보수 중. prism의 마지막 커밋은 2026년 10월 12일입니다.

prism은(는) 어디에 사용할 수 있나요?

백엔드가 구현되기 전에 프런트엔드 개발자가 API를 기반으로 작업하도록 합니다. 테스트 중 실제 API가 OpenAPI 계약과 계속 일치하는지 확인합니다. CI 파이프라인에서 모의 API 의존성을 실행합니다. 실제와 유사한 샘플 응답을 사용해 이해관계자에게 API 설계를 시연합니다.

prism는 어떻게 설치하나요?

npm으로 Prism CLI를 설치합니다(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