Documentação — Fake API

API RESTful completa e flexível em Node.js + Express, com arquitetura limpa e separação de responsabilidades. Ideal para protótipos, testes e simulação de contratos REST.

Instalação rápida

git clone https://github.com/samuelikz/fakeapi.git
cd fakeapi

npm install

cp env.example .env
# ajuste as variáveis conforme necessário

npm run dev   # http://localhost:8000
# ou:
npm run build && npm start

Configuração (.env)

Crie o arquivo .env a partir de env.example e ajuste conforme seu ambiente:

Endpoints

Health

Sistema

• GET /__resources — lista recursos e contagem.
• GET /_docs — documentação embutida.
• POST /_ensure/:resource — cria um recurso caso não exista.
• POST /_reset — reseta o banco (dev).

CRUD dinâmico

Para qualquer recurso (ex.: posts, users):

• GET /:resource — lista com paginação/filtros
• GET /:resource/:id — obtém item
• POST /:resource — cria item
• PUT /:resource/:id — atualiza total
• PATCH /:resource/:id — atualiza parcial
• DELETE /:resource/:id — remove

Parâmetros de consulta

• _page — página (padrão: 1)
• _limit — itens por página (padrão: 50, máximo: 100)
• _meta — inclui metadados de paginação (0 ou 1)
• q — busca textual em todos os campos

Exemplos (curl)

curl -s http://localhost:8000/posts | jq

curl -s "http://localhost:8000/posts?q=node&_page=2&_limit=10&_meta=1" | jq

curl -s -X POST http://localhost:8000/posts \
  -H 'Content-Type: application/json' \
  -d '{"title":"Bem-vindo à Fake API","content":"API RESTful com arquitetura limpa.","author":"Samuel","tags":["api","rest","nodejs"]}' | jq

curl -s -X PUT http://localhost:8000/posts/1 \
  -H 'Content-Type: application/json' \
  -d '{"title":"Título atualizado","content":"Conteúdo atualizado","author":"Samuel"}' | jq

curl -s -X PATCH http://localhost:8000/posts/1 \
  -H 'Content-Type: application/json' \
  -d '{"title":"Apenas o título"}' | jq

curl -s -X DELETE http://localhost:8000/posts/1 -i

Status Codes

• 200 OK — sucesso
• 201 Created — item criado
• 204 No Content — removido / sem corpo
• 400 Bad Request — parâmetros inválidos
• 404 Not Found — recurso/ID inexistente
• 422 Unprocessable Entity — validação falhou
• 500 Internal Server Error — erro interno
• 503 Service Unavailable — não saudável

Estrutura do banco

{
  "posts": [
    {
      "id": 1,
      "title": "Bem-vindo à Fake API",
      "content": "Esta é uma API RESTful completa com arquitetura limpa e separação de responsabilidades.",
      "author": "Samuel",
      "tags": ["api","rest","nodejs"],
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z"
    }
  ],
  "users": [
    {
      "id": 1,
      "name": "João Silva",
      "email": "[email protected]",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z"
    }
  ]
}

Arquitetura

src/
├─ config/            # app & database config
├─ controllers/       # health, resource, system
├─ middleware/        # cors, logger, validation
├─ routes/            # health, resource, system
├─ services/          # database service
├─ utils/             # file utils
└─ server.js          # bootstrap da aplicação

Logs & Erros

[2024-01-01T00:00:00.000Z] GET /posts - Started
[2024-01-01T00:00:00.000Z] 🟢 GET /posts -> 200 (15ms)
[2024-01-01T00:00:00.000Z] 🔴 POST /posts -> 400 (8ms)
[2024-01-01T00:00:00.000Z] 💚 GET /health -> 200 (5ms)

Exemplo de erro padronizado:

{
  "error": "Bad Request",
  "message": "Invalid ID parameter. ID must be a positive number."
}

Interface Web

• / — home com passos de uso e exemplos
• /_docs — documentação embutida

Contribuindo

1. Faça fork do repositório
2. Crie branch: git checkout -b feature/minha-feature
3. Commits descritivos e testes
4. Abra um Pull Request

Licença

Licenciado sob MIT. Veja LICENSE.

FAQ