Pular para o conteúdo principal

Instalação

Este guia mostra como instalar e configurar o Json-To-Mock-Api em diferentes ambientes.

📋 Pré-requisitos​

Antes de instalar o Json-To-Mock-Api, certifique-se de ter:

  • Node.js versão 16.0 ou superior
  • npm versão 7.0 ou superior (incluído com Node.js)

Verificando os Pré-requisitos​

# Verificar versão do Node.js
node --version

# Verificar versão do npm
npm --version

🚀 Métodos de Instalação​

1. Instalação Global (Recomendado)​

A instalação global permite usar o comando json-to-mock-api em qualquer lugar do sistema:

npm install -g json-to-mock-api

Uso após instalação global:

json-to-mock-api -f db.json
json-to-mock-api -d ./data

2. Uso com npx (Sem Instalação)​

Use diretamente sem instalar globalmente:

# Sempre usa a versão mais recente
npx --yes json-to-mock-api -f db.json

# Especificar versão
npx json-to-mock-api@latest -d ./data

3. Instalação Local no Projeto​

Para projetos específicos, instale como dependência de desenvolvimento:

# Instalar como dev dependency
npm install --save-dev json-to-mock-api

# Ou com yarn
yarn add --dev json-to-mock-api

Uso em projetos locais:

# Via npm scripts
npx json-to-mock-api -f db.json

# Ou adicionar ao package.json
package.json
{
  "scripts": {
    "mock-server": "json-to-mock-api -f db.json",
    "mock-dev": "json-to-mock-api -d ./mock-data -p 3001"
  }
}

🔧 Configuração Inicial​

Estrutura Básica de Projeto​

Após a instalação, crie a estrutura básica:

meu-projeto/
├── mock-data/
│   ├── users.json
│   ├── products.json
│   └── api/
│       └── orders.json
├── db.json
└── package.json

Arquivo de Configuração Básico​

Crie um arquivo db.json para começar:

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" }
        ],
        "headers": {
          "X-Total-Count": "2",
          "X-API-Version": "1.0"
        }
      },
      "POST": {
        "body": { "id": 3, "name": "Novo Usuário", "email": "novo@email.com" },
        "headers": {
          "Location": "/users/3"
        },
        "cookies": {
          "user_created": "true"
        }
      }
    }
  }
}

🧪 Verificando a Instalação​

Teste Básico​

  1. Verificar se o comando está disponível:
json-to-mock-api --version
  1. Criar um arquivo de teste:
test.json
{
  "endpoints": {
    "hello": {
      "GET": {
        "body": { "message": "Hello World!" }
      }
    }
  }
}
  1. Iniciar o servidor:
json-to-mock-api -f test.json
  1. Verificar se está funcionando:

Teste com Modo Pasta​

  1. Criar estrutura de pastas:
mkdir mock-data
echo '[{"id": 1, "name": "Teste"}]' > mock-data/users.json
  1. Iniciar em modo pasta:
json-to-mock-api -d mock-data

🐛 Solução de Problemas​

Problemas Comuns​

Erro: "comando não encontrado"​

Problema: json-to-mock-api: command not found

Soluções:

# 1. Verificar se foi instalado globalmente
npm list -g json-to-mock-api

# 2. Reinstalar globalmente
npm install -g json-to-mock-api

# 3. Usar npx como alternativa
npx json-to-mock-api --version

Erro de Permissão (Linux/Mac)​

Problema: EACCES: permission denied

Soluções:

# 1. Usar sudo (não recomendado)
sudo npm install -g json-to-mock-api

# 2. Configurar npm para pasta do usuário (recomendado)
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
npm install -g json-to-mock-api

Porta em Uso​

Problema: Error: listen EADDRINUSE :::3000

Soluções:

# Usar porta diferente
json-to-mock-api -f db.json -p 3001

# Ou encontrar processo usando a porta
lsof -ti:3000 | xargs kill -9  # Mac/Linux
netstat -ano | findstr :3000   # Windows

Verificação de Saúde​

Execute este script para verificar se tudo está funcionando:

#!/bin/bash
echo "🔍 Verificando instalação do Json-To-Mock-Api..."

# Verificar Node.js
if command -v node &> /dev/null; then
    echo "✅ Node.js: $(node --version)"
else
    echo "❌ Node.js não encontrado"
    exit 1
fi

# Verificar npm
if command -v npm &> /dev/null; then
    echo "✅ npm: $(npm --version)"
else
    echo "❌ npm não encontrado"
    exit 1
fi

# Verificar json-to-mock-api
if command -v json-to-mock-api &> /dev/null; then
    echo "✅ json-to-mock-api: $(json-to-mock-api --version)"
else
    echo "⚠️  json-to-mock-api não encontrado globalmente"
    echo "💡 Tente: npx json-to-mock-api --version"
fi

echo "🎉 Verificação concluída!"

📦 Atualizações​

Verificar Versão Atual​

# Versão instalada globalmente
npm list -g json-to-mock-api

# Versão mais recente disponível
npm view json-to-mock-api version

Atualizar para Versão Mais Recente​

# Atualizar instalação global
npm update -g json-to-mock-api

# Ou reinstalar
npm uninstall -g json-to-mock-api
npm install -g json-to-mock-api@latest

🔄 Desinstalação​

Se precisar remover o Json-To-Mock-Api:

# Desinstalar globalmente
npm uninstall -g json-to-mock-api

# Desinstalar localmente
npm uninstall json-to-mock-api

Próximo passo: Agora que você tem o Json-To-Mock-Api instalado, vamos aprender como usá-lo no Guia de Uso! 🚀