Api responsável por servir o OfficeStore-WEB, criado com NodeJs e ExpressJs, utilizando o ORM sequelize com postgres alem autenticação OAuth2.
A apricação utiliza autenticação do tipo Bearer Token, que deve ser incluída no header das requisições.
Authorization: Bearer <token>
Descrição das rotas disponiveis na api, no modelo:
<metodo> <autenticada?> Titulo - URL - params - body
Em toda requisição autenticada 👮, deve conter o token de autenticação capturado na rota de autenticação.
- Sem parâmetros
- Sem corpo
- Sem Parâmetro
- Corpo:
{
"email": <string> <opcional se existir cnpj>,
"cnpj": <string> <opcional se existir email>,
"password": <string> <obrigatório>,
}
- Sem parâmetros
- Sem corpo
- Sem parâmetros
- Corpo:
{
"name":<string> <obrigatório>,
"email":<string> <obrigatório>,
"cnpj":<string> <obrigatório>,
"password":<string> <obrigatório>,
}
- Sem parâmetros
- Corpo:
{
"name":<string>,
"email":<string>,
"cnpj":<string>,
"password":<string>,
"confirmPassword":<string> <obrigatório se possuir password>,
"oldPassword":<string> <obrigatório se possuir password>,
}
- Sem parâmetros
- Sem corpo
- Parâmetros:
| Query | Tipo | Descrição | Padrão |
|---|---|---|---|
| page | <inteiro> |
parâmetro de paginação | 1 |
| per_page | <inteiro> |
numero de item por pagina | 1 |
| search | <string> |
pesquisa item por nome ou cnpj | <null> |
- Sem corpo
- Sem parâmetros
- Corpo:
{
"name":<string> <obrigatório>
"value":<float> <obrigatório>
}
- Sem parâmetros
- Corpo:
{
"name":<string>
"value":<float>
}
- Sem parâmetros
- Sem corpo
Para executar a api, alguns simples passos devem ser seguidos.
Após baixar uma copia deste repositório, com o terminal em tua pasta raiz, deve-se instalar todos os seus pacotes com o seu gerenciador preferido.
$ yarn install ou $ npm i
Os parâmetros de ambiente devem ser criados, em um arquivo .env, seque no repositório um arquivo de exemplo como base. A base de dados utilizada foi o POSTGRES.
A base de dados usada é o postgres, como sendo uma base relacional, precisamos fazer a construção de suas tabelas e popula-las, com os seguintes comandos:
$ yarn sequelize db:migrate ou $ npm sequelize db:migrate
$ yarn sequelize db:seed:all ou $ npm sequelize db:seed:all
Por fim, ao rodar a aplicação com yarn dev ou npm run dev, ela estara pronta na porta 3333.