Pular para o conteúdo principal

Introdução

Bem-vindo ao Json-To-Mock-Api! 🚀

Uma biblioteca CLI simples e poderosa para criar servidores REST a partir de arquivos JSON ou pastas com múltiplos arquivos JSON, com documentação automática Swagger integrada.

✨ Funcionalidades Principais​

  • 📋 Documentação Automática Swagger: Interface interativa para testar e documentar APIs
  • 🔧 Headers Mockados: Suporte a headers customizados de resposta para simulações realistas
  • 🍪 Cookies Mockados: Suporte a cookies customizados de resposta com opções avançadas
  • 🔄 Schemas Inline: Schemas gerados automaticamente baseados nos dados reais
  • 🚀 Múltiplos Métodos HTTP: Suporte a GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD
  • 📁 Modo Pasta ou Arquivo: Carregamento de múltiplos arquivos JSON ou arquivo único
  • 🌐 CORS Habilitado: Pronto para uso em aplicações web
  • 🔗 Parâmetros de Path: Suporte automático a parâmetros como :id, :userId, etc.
  • 🏷️ Agrupamento Inteligente: Endpoints agrupados por pasta ou arquivo de origem

🎯 Por que usar o Json-To-Mock-Api?​

Para Desenvolvedores Frontend​

  • Desenvolvimento Independente: Não dependa do backend estar pronto
  • Testes Realistas: Simule comportamentos reais de API com headers e cookies
  • Prototipagem Rápida: Crie APIs mockadas em minutos

Para Equipes de Desenvolvimento​

  • Documentação Automática: Swagger UI gerado automaticamente
  • Colaboração: Diferentes desenvolvedores podem trabalhar em endpoints separados
  • Padronização: Estrutura consistente para todos os mocks

Para Testes e QA​

  • Cenários Controlados: Simule diferentes respostas e comportamentos
  • Headers e Cookies: Teste fluxos completos de autenticação e sessão
  • Ambientes Isolados: Testes sem dependências externas

🚀 Início Rápido​

Instalação​

# Instalação global
npm install -g json-to-mock-api

# Ou use diretamente com npx
npx --yes json-to-mock-api

Primeiro Uso​

  1. Crie um arquivo JSON simples:
db.json
{
  "endpoints": {
    "users": {
      "GET": {
        "body": [
          { "id": 1, "name": "João Silva", "email": "joao@email.com" },
          { "id": 2, "name": "Maria Santos", "email": "maria@email.com" }
        ]
      }
    }
  }
}
  1. Inicie o servidor:
npx json-to-mock-api -f db.json
  1. Acesse a documentação:

📚 Próximos Passos​

🤝 Contribuindo​

O Json-To-Mock-Api é um projeto open source. Contribuições são bem-vindas!

Pronto para começar? Vamos para a instalação! 🎉