Repolode
Enviar
stoplightio

stoplightio/prism

CLI e servidor HTTP que transformam arquivos OpenAPI v2/v3 e Postman Collection em APIs simuladas, com validação de requisições e um proxy de validação.

Alternativa open source a:Postman

Ver no GitHubSite
Estrelas
5,052
Forks
414
Issues abertas
147
Último commit
há 10 dias

O que é?

Prism é um conjunto de pacotes para simulação de APIs e testes de contrato. Com um documento OpenAPI v2, OpenAPI v3.x ou Postman Collection, ele inicia um servidor HTTP que retorna respostas estruturadas de acordo com a especificação, permitindo que as equipes de frontend e de clientes trabalhem antes de o backend existir.

A mesma ferramenta pode funcionar como um proxy de validação à frente de uma API real. Ela verifica o tráfego de acordo com a descrição da API e aponta divergências entre a implementação e o contrato. Também oferece suporte à negociação de conteúdo e à validação de segurança. O Prism é executado pela linha de comando com comandos como `prism mock` e `prism proxy`, e requer Node.js 18.20.1 ou posterior.

Servidores mock hospedados também são oferecidos pela plataforma comercial da Stoplight e pelo Stoplight Studio, que usam o Prism internamente. Registrar tráfego para gerar um documento OpenAPI e persistir dados de mock são recursos listados como planejados, não disponíveis atualmente.

Recursos principais

  • 01Gera um servidor HTTP mock a partir de arquivos OpenAPI v2, v3.0, v3.1 ou Postman Collection.
  • 02Valida requisições e respostas de acordo com a especificação da API.
  • 03Funciona como proxy de validação à frente de uma API ativa para apontar incompatibilidades com o contrato.
  • 04Oferece suporte à negociação de conteúdo e à validação de segurança.
  • 05É executado pela linha de comando e pode ser usado em integração contínua.

Casos de uso

  • Permitir que desenvolvedores de frontend trabalhem com uma API antes de o backend ser implementado.
  • Verificar durante os testes se uma API ativa continua de acordo com seu contrato OpenAPI.
  • Executar dependências de API simuladas em pipelines de CI.
  • Demonstrar o design de uma API a stakeholders com respostas de exemplo realistas.

Início rápido

  1. 1

    Instale o Prism CLI com npm (requer Node.js 18.20.1 ou superior)

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

    Execute um servidor simulado a partir de um documento OpenAPI

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

    Ou execute o proxy de validação na frente de uma API existente

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

Antes de usar

  • Requer Node.js 18.20.1 ou superior; no Node 18.x, é necessário usar pelo menos a versão 18.16.

Tópicos

#openapi#api-testing#mock-server#contract-testing#swagger#postman#cli#hacktoberfest#http-proxy#mocking

Perguntas frequentes

O que é prism?
CLI e servidor HTTP que transformam arquivos OpenAPI v2/v3 e Postman Collection em APIs simuladas, com validação de requisições e um proxy de validação. Prism é um conjunto de pacotes para simulação de APIs e testes de contrato. Com um documento OpenAPI v2, OpenAPI v3.x ou Postman Collection, ele inicia um servidor HTTP que retorna respostas estruturadas de acordo com a especificação, permitindo que as equipes de frontend e de clientes trabalhem antes de o backend existir.
prism é gratuito? Qual é a licença?
prism é open source sob a licença Apache-2.0. Confira os termos da licença antes de usá-lo em produtos comerciais.
prism ainda é mantido?
Manutenção ativa. O último commit de prism foi em 12 de out. de 2026.
Para que posso usar prism?
Permitir que desenvolvedores de frontend trabalhem com uma API antes de o backend ser implementado. Verificar durante os testes se uma API ativa continua de acordo com seu contrato OpenAPI. Executar dependências de API simuladas em pipelines de CI. Demonstrar o design de uma API a stakeholders com respostas de exemplo realistas.
Como instalar prism?
Instale o Prism CLI com npm (requer Node.js 18.20.1 ou superior): npm install -g @stoplight/prism-cli Execute um servidor simulado a partir de um documento OpenAPI: prism mock https://raw.githack.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml Ou execute o proxy de validação na frente de uma API existente: prism proxy examples/petstore.oas2.yaml https://petstore.swagger.io/v2
Onde consigo prism?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/stoplightio/prism

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados