API REST Fake com json-server

Você está desenvolvendo uma aplicação front-end Web, mobile ou outra plataforma usando JavaScript, React, Flutter ou outro framework e deciciu pelo paradigma "API REST". O problema é que você ainda não tem o back-end, a API a ser consumida.

Essa dica ajuda a evitar atrasos no processo usando uma "API Fake" simples e rápida, que pode ser lançada em qualquer aplicativo em poucos minutos.

Vamos criar uma API "fake" para fazer testes rápidos com nossos front-end e para isso vamos precisar do "Node.js" e do "json-server". O "Node.js" já é figurinha carimbada no desktop do desenvolvedor, mas, caso não tenha, é só baixar e instalar daqui.

Vamos aos passos!

• Abra seu projeto front-end na sua IDE (Integrated Developer Envoronment) favorita. Então, abra um terminal, "PowerShell" ou mesmo "Command Prompt";

• Crie uma pasta para sua API e entre nela com os comandos:

mkdir apifake
cd apifake

• Inicie um novo aplicativo "Node.js" com o comando:

npm init

• Responda todas as perguntas com atenção ou, simplesmente teclando [Enter] para cada uma;

• Para evitar que os pacotes "Node.js" sejam enviados para o Github.com, adicione as linhas abaixo no final do arquivo '.gitignore' na raiz do seu projeto. Se este arquivo não existe, crie-o!

# Ignorar a pasta node_modules dentro de apifake
apifake/node_modules/

• Instale o json-server com o comando:

npm install -g json-server@0.17.4

• Localize a pasta criada para sua "API", pelo gerenciador de arquivos da IDE;

• Dentro dela, crie um arquivo "db.json" e salve nele o conteúdo abaixo:

{
    "contacts": [],
    "items": [],
    "users": []
}

Neste "db.json" criamos 3 endpoints: "contacts", "users" e "items". Você pode alterar o JSON para refletir sua "futura" API real. Também é possível iniciar a API já com dados cadastrados. Veja o "db.json" abaixo como exemplo:

{

  "contacts": [],

  "items": [],

  "users": [

    {

      "id": 1,

      "name": "Joca da Silva",

      "email": "joca@email.com",

      "password": "Senha@123",

      "birth": "2000-10-18",

      "photo": "3267198297632D4JM8DJ73.png",

      "status": "ON"

    }, {

      "id": 2,

      "name": "Marineuza Siriliano",

      "email": "marineuza@email.com",

      "password": "Senha@123",

      "birth": "1984-01-05",

      "photo": "FN87Y6J053280F6J0235D7.png",

      "status": "ON"

    }

  ]

}

•  Inicie o json-server com o comando:

npx json-server db.json -p 8080

Você verá uma saída no terminal informando que o servidor está rodando na porta 8080, onde as requisições para os endpoints serão recebidas.

Não feche este terminal enquanto faz os testes.

A lista de endpoints aparece no terminal e o 'db.json' será atualizado localmente. Também é possível acessar a API pelo navegador, no endereço http://localhost:8080.

Se ocorrer algum conflito com a porta 8080, altere-a no comando 'npx json-server db.json -p ####' para outro valor próximo.

Importante!

Como as dependências não são versionadas pelo Git, quando baixar/clonar este aplicativo do GitHub.com, antes de rodar a API, é necessário baixar os pacotes de dependência com os comandos:

cd apifake
npm install

Após as instalações, inclusive do próprio "json-server", inicie a API normalmente com o comando:

npx json-server db.json -p 8080

Conforme a documentação oficial do json-server, existem diversas opções de operação do aplicativo como filtros e ordenamentos. Consulte!

Referências

• json-server - https://github.com/typicode/json-server

• Node.js - https://nodejs.org/ 

• Sobre API REST - https://pt.wikipedia.org/wiki/REST 

• Sobre JSON - https://pt.wikipedia.org/wiki/JSON