# Prism

Prism is a toolkit for API mocking and contract testing built on OpenAPI v2, OpenAPI v3.x, and Postman Collection specifications. It is open source and self-hosted, installable on Docker Hub and Kubernetes (Helm).

Canonical page: https://ourlocalhost.com/app/6326/prism

## Description

Prism is a toolkit for API mocking and contract testing built on OpenAPI v2, OpenAPI v3.x, and Postman Collection specifications. It turns your API description file into a lifelike mock server and adds a validation proxy that checks requests and responses against the spec, so developers and API consumers can build against endpoints before a real backend exists. Host it yourself to keep your API contracts and traffic under your own control.

## Platform availability

Available on 1 of 10 platforms: Helm.

## Health score

75/100 (Good), based on 5 of 5 factors.
- Maintained: 100 (last commit 2 days ago)
- Popular: 74 (5,072 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Light to run: 70 (1 GB minimum RAM)
- Security check: 72 (no serious findings, 2 minor, CI, tests, OpenSSF Scorecard 4.8/10)

## Links

- Official website: https://stoplight.io/open-source/prism
- GitHub: https://github.com/stoplightio/prism
- Docker Hub: https://hub.docker.com/r/stoplight/prism/
- Documentation: https://github.com/stoplightio/prism
- Kubernetes (Helm): https://artifacthub.io/packages/helm/av1o-charts/prism

## Common questions

### How do I install self-hosted Prism from the command line?

Install the CLI globally with npm install -g @stoplight/prism-cli.

### How do I start a Prism mock server?

Run the prism mock command with a URL to an OpenAPI document.

### How do I use Prism as a validation proxy?

Run the prism proxy command with an OpenAPI document and the real API endpoint.

### Which API specification formats does Prism support?

It supports OpenAPI v3.1, OpenAPI v3.0, OpenAPI v2.0, and Postman Collections.

---
Source: Our Local Host (https://ourlocalhost.com/app/6326/prism), the self-hosted and open-source app directory.
