First project integrante da iniciação do back-end, onde praticamos toda a base de criação de uma API vinculada a um banco de dados real.
- NodeJS
- Typescript
- Express
- SQL e SQLite
- Knex
- Postman
https://dbdiagram.io/d/63c6e8e5296d97641d7a4666
Documentação da API com as instruções de uso de cada endpoint da aplicação Labecommerce.
-
Endpoints
- Create user
- Get all users
- Edit user by id
- Delete user by id
- Create product
- Get all products
- Get product by name
- Get product by id
- Edit product by id
- Delete product by id
- Create purchase
- Edit purchase by id
- Get all purchases
- Get purchase by id
- Delete purchase by id
Não precisa cadastrar o mesmo nome, email e quaisquer outros valores vistos aqui nos exemplos de saída. Porém, lembre-se de respeitar a estrutura pedida no banco de dados (nome das tabelas e colunas) e os nomes das propriedades na resposta da API.
Colunas a mais na tabela não tem problema, por exemplo adicionar uma 'category' dentro da tabela 'products', mas a falta de uma coluna ou propriedade na resposta será considerada falha de implementação!
Requisições para a API devem seguir os padrões:
Método | Descrição |
---|---|
GET |
Retorna informações de um ou mais registros. |
POST |
Utilizado para criar um novo registro. |
PUT |
Atualiza dados de um registro ou altera sua situação. |
DELETE |
Remove um registro do sistema. |
Código | Descrição |
---|---|
200 |
Requisição executada com sucesso (success). |
201 |
Dados creado com sucesso(sucess). |
400 |
Erros de validação ou os campos informados não existem no sistema. |
404 |
Registro pesquisado não encontrado (Not found). |
500 |
Erro inesperado. |
Esse é um exemplo das intruções de como você configura o projeto localmente. Para ter uma copia local, siga os passos abaixo:
- Install NPM TypeScript packages
npm init -y (cria package.json)
npm i -g typescript (faz só 1 vez)
npm i typescript -D (instala typescript no projeto)
npx tsc -init (criar tsconfig.json)
- Install NPM Express packages
npm install express
npm install @types/express -D
- Install NPM Cors packages
npm install cors
npm install @types/cors -D
- Install NPM Node packages
npm install ts-node-dev -D
- Run NPM developer
npm run dev
Uma API onde pode ser criado um site de ecommerce, com usuário, produtos e compras.
Manassés Almeida - [email protected]
Project Link: (https://github.com/manassesdev2)
- A DEUS por me proporcionar todos os recursos necessários para o projeto
- Aos professores da Labenu e aos colegas que me ajudaram no decorrer do projeto
- Minha esposa e meus familiares pelo apoio ao longo da construção do projeto