Skip to main content

json-server | Node.js

  • json-server | Node.js

🔧 Comando

npm install -g json-server

🧠 O que o comando faz?

  • npm – Node Package Manager, usado para instalar pacotes do ecossistema Node.js.
  • install – Indica que você quer instalar um pacote.
  • -g – Instala o pacote globalmente, ou seja, estará disponível em qualquer lugar do sistema (e não apenas no projeto atual).
  • json-server – Nome do pacote a ser instalado.

📌 Pré-requisitos

Antes de rodar o comando, você precisa:

  1. Ter o Node.js e o npm instalados:


🛠️ Para que serve o json-server?

Ele cria um servidor REST completo com:

  • Rotas GET, POST, PUT, PATCH, DELETE
  • Suporte a filtros, paginação, ordenação, busca
  • Watch mode (auto-reload ao alterar o arquivo JSON)

Tudo isso baseado em um simples arquivo db.json como este:

{
"posts": [
{ "id": 1, "title": "Hello World" }
],
"comments": [
{ "id": 1, "body": "Nice post!", "postId": 1 }
]
}

🚀 Como usar depois da instalação

1. Criar o arquivo db.json

echo '{ "posts": [ { "id": 1, "title": "Hello World" } ] }' > db.json

2. Iniciar o servidor

json-server --watch db.json

Por padrão, a API estará disponível em: http://localhost:3000


🌐 Exemplo de rotas geradas

Com o exemplo acima (posts), você terá:

MétodoRotaDescrição
GET/postsLista todos os posts
GET/posts/1Busca post por ID
POST/postsCria novo post
PUT/posts/1Atualiza post inteiro
PATCH/posts/1Atualiza parcialmente
DELETE/posts/1Remove post

🧪 Exemplos de uso com curl

Criar novo post

curl -X POST -H "Content-Type: application/json" -d '{"title": "Novo post"}' http://localhost:3000/posts

Atualizar post

curl -X PATCH -H "Content-Type: application/json" -d '{"title": "Atualizado"}' http://localhost:3000/posts/1

🧯 Como remover

Caso deseje remover o json-server globalmente:

npm uninstall -g json-server