Criando uma API Falsa com JSON-Server

Node.js 31 de Out de 2023

*Texto de Paulo Clemente
Desenvolvedor e redator de mídias sociais na Rocketseat

Quando desenvolvemos aplicações, muitas vezes precisamos de uma API para testar nossos aplicativos antes que o backend esteja realmente pronto. É aí que o JSON-Server é uma ótima opção.

O JSON-Server é uma ferramenta que permite criar facilmente uma API falsa com base em arquivos JSON. Neste artigo, exploraremos como usar o JSON-Server para criar uma API falsa para desenvolvimento e teste.

O que é JSON-Server?

JSON-Server é uma biblioteca Node.js que simula uma API RESTful a partir de um arquivo JSON. Ele é uma ferramenta extremamente útil para desenvolvedores que desejam criar um backend falso para suas aplicações. Com o JSON-Server, você pode criar, atualizar, excluir e recuperar recursos como faria com uma API real. No entanto, os dados são armazenados em um arquivo JSON, o que torna o processo rápido e fácil.

Instalação

Para começar, você precisa ter o Node.js instalado em seu sistema. Se você ainda não o tem, pode fazer o download em nodejs.org.

Depois de ter o Node.js instalado, você pode instalar o JSON-Server globalmente usando o seguinte comando:

npm i json-server -D

Criando um Arquivo JSON

Antes de usar o JSON-Server, você precisa criar um arquivo JSON que representará seus dados. Por exemplo, suponha que você esteja criando uma aplicação de lista de tarefas. Seu arquivo JSON poderia ter o seguinte formato:

{
  "tarefas": [
    { "id": 1, "titulo": "Comprar leite", "concluida": false },
    { "id": 2, "titulo": "Pagar contas", "concluida": false },
    { "id": 3, "titulo": "Estudar programação", "concluida": true }
  ]
}

Inicializando o JSON-Server

Agora que você tem seu arquivo JSON de dados, é hora de iniciar o JSON-Server. Use o seguinte comando na pasta onde está localizado o arquivo JSON:

json-server --watch server.json

Isso iniciará o servidor falso e disponibilizará sua API em http://localhost:3000. Você pode acessar os recursos da API usando as rotas padrão, como /tarefas para listar todas as tarefas.

Testando a API

Com o JSON-Server em execução, você pode testar sua API falsa fazendo requisições HTTP para as rotas disponíveis. Por exemplo, você pode usar o curl ou um cliente HTTP, como o Postman, para fazer solicitações GET, POST, PUT e DELETE.

Aqui estão alguns exemplos de como você pode interagir com sua API falsa:

GET /tarefas: Recupera todas as tarefas.
GET /tarefas/1: Recupera a tarefa com ID 1.
POST /tarefas: Adiciona uma nova tarefa.
PUT /tarefas/1: Atualiza a tarefa com ID 1.
DELETE /tarefas/1: Exclui a tarefa com ID 1.

Personalizando a API

O JSON-Server também oferece a capacidade de personalizar sua API falsa. Você pode criar rotas adicionais, definir relacionamentos entre recursos e muito mais. Tudo isso é feito através de um arquivo server.json onde você pode configurar seu banco de dados falso.

O JSON-Server é simples de configurar e usar, e permite que você simule facilmente um backend real. Isso é particularmente útil durante o desenvolvimento e teste de aplicativos, quando o backend real pode não estar disponível. Ele pode economizar tempo e facilitar o processo de teste de suas aplicações.

Esperamos que este artigo tenha sido útil para você entender como criar uma API falsa com o JSON-Server.

Agora você pode começar a desenvolver e testar suas aplicações sem a necessidade de um backend real. Divirta-se codando!