JSON Server: criação rápida de APIs fakes (mock)3 min read

Categoria: Engenharia de Softwares Ferramentas de Desenvolvimento Front-end Node.js

Você é dev front-end e está desenvolvendo um sistema complexo. O engenheiro back-end avisa em um daily que as APIs não vão estar prontas antes de você começar. A solução: trabalhar com um back-end mockado. Mas, qual ferramenta para esta finalidade você deve escolher? Eis que existe uma MUITO simples de usar: JSON Server.

O que é o JSON Server?

O JSON Server é uma ferramenta de linha de comando Node.js que permite ao usuário criar uma API REST falsa. Com apenas um arquivo JSON e a biblioteca instalada em sua máquina, é possível simular o comportamento de uma API REST completa com recursos como rotas, métodos HTTP, filtragem, ordenação e muito mais.

A página oficial do projeto pode ser encontrada, aqui: https://github.com/typicode/json-server

Por que usar o JSON Server?

Como comentei no início deste post, durante o desenvolvimento de aplicações frontend, pode ser crucial ter uma API disponível para interação. No entanto, se a API real não estiver pronta ou se os desenvolvedores frontend quiserem trabalhar independentemente do backend, uma API falsa pode ser a solução.

Além disso, o JSON Server é uma excelente ferramenta para prototipagem rápida. Se você precisa de uma API com dados para testar a funcionalidade da aplicação, você pode usar o JSON Server para criar essa API rapidamente (e sim: funciona muito bem para isso, acredite – as minas e manos de produto piram HAHAHA)

Como usar o JSON Server

Aqui está um exemplo simples de como usar o JSON Server.

1 – Instalação

Primeiro, você precisa ter o Node.js e o npm (gerenciador de pacotes do Node.js) instalados em seu sistema. Em seguida, instale o JSON Server globalmente usando npm:

npm install -g json-server

2 – Criando um arquivo JSON

Em seguida, você precisa de um arquivo JSON para servir como o “banco de dados” para sua API falsa. Aqui está um exemplo:

{
  "posts": [
    { "id": 1, "title": "json-server", "author": "fabioDeveloper" }
  ],
  "comments": [
    { "id": 1, "body": "Algum comentário", "postId": 1 }
  ],
  "profile": { "name": "typicode" }
}

3 – Iniciando o servidor

Para iniciar o servidor, basta executar o comando json-server seguido pelo nome do arquivo JSON que foi criado no passo anterior:

json-server --watch db.json

Isso iniciará o servidor, e sua API falsa estará disponível no endereço: http://localhost:3000 (é possível alterar a porta de início da API. Procure o parâmetro –port na documentação oficial).

4 – Interagindo com a API

Agora você pode interagir com sua API usando todos os métodos HTTP padrão (GET, POST, PUT, PATCH, DELETE). Por exemplo, para obter todos os posts, você pode acessar http://localhost:3000/posts.

Conclusão

O JSON Server é uma ferramenta incrivelmente útil para desenvolvedores frontend e equipes que precisam de uma maneira rápida e fácil de criar uma API REST fake/mockada. Se você ainda não experimentou o JSON Server, dê uma chance!

Fontes:

• JSON Server (GitHub Oficial) – https://github.com/typicode/json-server
• Node.js – https://nodejs.org/