API teste criada com a utilização de Node.js, framework Express.js e o banco de dados Postgres. O projeto foi baseado no vídeo "API REST NodeJS em menos de 1h: Todo app com Express e Postgres (SQL) - deploy no Heroku" do canal Dev & Design como parte de um projeto pessoal para o estudo de criação de API.
Foi utilizado o ElephantSQL para a realização dessa API. Para utilizá-lo siga as instruções:
- Crie uma conta no ElephantSQL;
- Configure o Banco de dados;
- Crie as tabelas
usersetodos.
Para usar a API, você precisa ter o Node.js instalado em seu sistema. Depois de instalados, siga os seguintes passos:
- Clone o repositório para sua máquina local;
- Abra o terminal e navegue até o diretório do projeto;
- Execute o comando
npm installpara instalar as dependências; - Crie um arquivo
.envna raiz do projeto e configure as variáveis de ambiente necessárias:
POSTGRES_URL = <a url disponibilizada no ElephantSQL>
- Execute o comando
npm devpara iniciar a API.
- OBS: Para encontrar a URL no site do ElephantSQL é preciso clicar na instância criada e ir em
Datails.
A API possui os seguintes endpoints:
- Retorna todos os usuários.
- Retorna os dados (to-do) de um id específico.
- Cria uma sessão para um user.
- Cria um to-do em um id específico.
- Atualiza um dado específico (to-do específico) de um user também específico.
- Remove um dado específico (to-do específico) de um user também específico.
Vídeo utilizado como suporte para a criação da API.
As ferramentas utilizadas para a criação dessa API:
- Express - Framework utilizada para a criação da API
- Insomnia - é uma ferramenta Open Source para desenvolvimento/teste de API Clients
- ElephantSQL - Banco de dados