/burger-queen-api

Página foi desenvolvida em Reactjs, JavaScript (ES6 +), HTML, CSS, SQLite e para validação dos endpoints foi utilizado o postman.

Primary LanguageJavaScript

Burger Queen - API com Node.js

Índice

1. Preâmbulo

Um pequeno restaurante de hambúrgueres, que está crescendo, precisa de um sistema através do qual ele possa receber pedidos usando um tablet e enviá-los para a cozinha para que eles sejam preparados de forma eficiente.

Nossa cliente nos pediu para desenvolver uma API que possa ser integrada com uma interface, na qual outra equipe de desenvolvedoras está trabalhando.

2. Resumo do projeto

Por uma API, neste caso, nos referimos a um servidor web, que é basicamente um programa que escuta uma porta de rede, através da qual podemos enviar requisições (request) e obter respostas (response).

Um servidor web deve gerenciar as requisições recebidas e produzir respostas àquelas requisições que serão enviadas de volta para o cliente. Quando falamos sobre aplcações de servidor, isso implica uma arquitetura cliente / servidor, onde o cliente é o programa que faz as requisições através de uma rede (por exemplo, o navegador, cURL, etc), e o servidor é o programa que recebe essas requisições e respostas.

O Node.js nos permite criar servidores Web super eficientes de uma forma relativamente simples, tudo isso usando JavaScript!

A cliente nos deu um link para a documentação que especifica o comportamento esperado da API que iremos disponibilizar por HTTP. Lá você pode encontrar todos os detalhes de quais endpoints você deve implementar na aplicação, quais parâmetros são esperados, o que eles devem responder, etc.

3. Objetivos de aprendizagem

O principal objetivo de aprendizagem é ganhar experiência com o Node.js como uma ferramenta para desenvolver aplicações de servidores, junto com uma série de ferramentas comuns usadas neste tipo de contexto (Express como framework, MongoDB ou MySQL como banco de dados, ferramentas de autenticação, etc).

Neste projeto você irá construir um servidor web que deve servir JSON via HTTP e implementá-lo em um servidor na nuvem.

Para completar o projeto, você terá que se familiarizar com conceitos como rotas (routes), URLs, HTTP e REST (verbs, request, response, headers, body, status codes...), JSON, JWT (JSON Web Tokens), conexão com um banco de dados, variáveis de ambiente, deployment, etc.

4. Critérios mínimos de aceitação do projeto

4.1 API

Segundo o estabelecido pela documentação entregue por nossa cliente, a API deve conter os seguintes endpoints:

4.1,1 /

  • GET /

4.1.2 /auth

  • POST /auth

4.1.3 /users

  • GET /users
  • GET /users/:uid
  • POST /users
  • PUT /users/:uid
  • DELETE /users/:uid

4.1.4 /products

  • GET /products
  • GET /products/:productid
  • POST /products
  • PUT /products/:productid
  • DELETE /products/:productid

4.1.5 /orders

  • GET /orders
  • GET /orders/:orderid
  • POST /orders
  • PUT /orders/:orderid
  • DELETE /orders/:orderid

4.2 CLI

A cliente solicitou que o aplicativo tenha um comando npm start que deve ser utilizado para executar a nossa aplicação node e que também pode receber informações de configuração, como a porta na qual ouvir, em que banco de dados conectar, etc. Estes dados de configuração serão diferentes entre ambientes diferentes (desenvolvimento e produção, por exemplo).

4.2.1 Argumentos da linha de comando

Podemos especificar a porta na qual o aplicativo deve iniciar, passando um argumento ao rodar nosso programa:

# Execute a aplicação na prta 8888 usando npm
npm start 8888

4.2.2 Variáveis ​​de ambiente

Nossa aplicação usa as seguintes variáveis de ambiente:

  • PORT: Se uma porta não foi especificada como um argumento de linha de comando, podemos usar a variável de ambiente PORT para especificar a porta. Valor padrão 8080.
  • DB_URL: A conexão string de MongoDB ou MySQL. Quando executamos a aplicação em nosso computador (em ambiente de desenvolvimento), podemos usar o um banco de dados local, mas na produção teremos que usar as instâncias configuradas com docker-compose (mais sobre isso na próxima seção
  • JWT_SECRET: Nosso aplicativo implementa a autenticação usando o JWT (JSON Tokens da Web). Para poder assinar (criptografar) e verificar (descriptografar) os tokens, Nosso aplicativo precisa de um segredo. No local você pode usar o valor default (xxxxxxxx), mas é muito importante que você use um secret de verdade em produção.
  • ADMIN_EMAIL: Opcionalmente, podemos especificar um email e uma senha para o usuário admin (root). Se esses detalhes estiverem presentes, o aplicativo irá garantir que o usuário exista e que ele tenha permissões de administrador. Valor padrão admin @ localhost.
  • ADMIN_PASSWORD: se tivermos especificado um ADMIN_EMAIL, devemos passar também uma senha para o usuário admin. Valor padrão: changeme.

5. Dicas e leituras complementares

6. HTTP API Checklist

6.1 /

  • GET /

6.2 /auth

  • POST /auth

6.3 /users

  • GET /users
  • GET /users/:uid
  • POST /users
  • PUT /users/:uid
  • DELETE /users/:uid

6.4 /products

  • GET /products
  • GET /products/:productid
  • POST /products
  • PUT /products/:productid
  • DELETE /products/:productid

6.5 /orders

  • GET /orders
  • GET /orders/:orderid
  • POST /orders
  • PUT /orders/:orderid
  • DELETE /orders/:orderid