https://github.com/juliolmuller/ufpr-delivery-api
REST API para gestão de entregas
https://github.com/juliolmuller/ufpr-delivery-api
javascript node postgresql rest-api
Last synced: about 1 year ago
JSON representation
REST API para gestão de entregas
- Host: GitHub
- URL: https://github.com/juliolmuller/ufpr-delivery-api
- Owner: juliolmuller
- Archived: true
- Created: 2021-06-29T01:35:58.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-20T00:30:22.000Z (almost 5 years ago)
- Last Synced: 2025-03-04T21:33:46.876Z (over 1 year ago)
- Topics: javascript, node, postgresql, rest-api
- Language: JavaScript
- Homepage:
- Size: 629 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gestor de Entregas ACP
Aplicação construída como atividades avaliativas da disciplina de *Tópicos Especiais em Algorítmos* do curso de *Tecnologia em Análise e Desenvolvimento de Sistemas*, com o objetivo de servir como API REST para um sistema de gestão de consultas médicas, utilizando a plataforma **Node.js**.
## Diagrama de Classes
## Diagrama Relacional
## Executar o Projeto
Para executar o projeto é necessário ter a versõa 10 ou superior do [Node.js](https://nodejs.org/en/) e o gerenciador de pacotes NPM (geralmente incluso na instalação do *Node*) ou o [Yarn (v1)](https://yarnpkg.com/) para configuração dos pacotes de terceiros. Certifique-se também de que o gerenciador de pacote escolhido está disponível através da linha de comando, executando `npm -v` ou `yarn -v`.
Com os *Node.js* configurado, você poderá instalar as dependências a partir do comando:
```bash
# usando o Npm
$ npm install
# usando o Yarn
$ yarn
```
Antes de executar a aplicação, você também deve configurar as variáveis de ambiente, que serão responsáveis por configurações gerais do servidor e pela conexão com banco de dados. Altere então o arquivo `.env`, na raíz do projeto (se após a instalação não houver um arquivo `.env`, crie-o utilizando como base o arquivo `.env.example`). O SGBD utilizado no desenvolvimento foi o [MySQL (v5.7)](https://www.mysql.com/), COntudo, se preferir utilizar uma instância de banco de dados em conteiner, crie uma através do comando `docker-compose up`.
Para saber se o banco foi configurado com sucesso, execute as rotinas de *migrations* e *seeds*:
```bash
# usando o NPX (acompanha o NPM)
$ npx sequelize db:create # cria o banco de dados no SGBD
$ npm run migrate # executa as migrações dos esquemas
$ npm run seed:all # (opcional) adiciona dados fakes nas tabelas
# usando o Yarn
$ yarn sequelize db:create # cria o banco de dados no SGBD
$ yarn migrate # executa as migrações dos esquemas
$ yarn seed:all # (opcional) adiciona dados fakes nas tabelas
```
Por fim, para executar o servidor em modo de desenvolvimento (executado pelo pacote *nodemon*), utilize o comando `npm run dev` ou `yarn dev`.
## Endpoints
Os seguintes *endpoints* foram criados para atender aos requisitos:
| Path | Método | Perfil Autoriazado | Recurso |
| :------------------------ | :----: | :-----------------------: | :----------------------------------------------------------------------- |
| `/signin/{role}` | POST | - | Autentica um usuário de perfil `{role}` com base em *login* e *password* |
| `/associates` | GET | `admin` | Listar dados de todos os associados |
| `/associates/{cnpj}` | GET | `admin`/`assoc` | Acessar dados de associado com CNPJ `{cnpj}` |
| `/associates` | POST | `admin` | Cadastrar novo associado |
| `/associates/{id}` | PUT | `admin`/`assoc` | Atualizar dados de associado com ID `{id}` |
| `/associates/{id}` | DELETE | `admin` | Excluir cadastro de associado com ID `{id}` |
| `/customers` | GET | `admin`/`assoc` | Listar dados de todos os clientes |
| `/customers/{cnpj}` | GET | `admin`/`assoc` | Acessar dados de cliente com CNPJ `{cnpj}` |
| `/customers` | POST | `assoc` | Cadastrar novo cliente |
| `/customers/{id}` | PUT | `assoc` | Atualizar dados de cliente com ID `{id}` |
| `/customers/{id}` | DELETE | `assoc` | Excluir cadastro de cliente com ID `{id}` |
| `/motoboys` | GET | `admin`/`assoc` | Listar dados de todos os motoboys |
| `/motoboys/{cpf}` | GET | `admin`/`assoc`/`motoboy` | Acessar dados de motoboy com CPF `{cpf}` |
| `/motoboys` | POST | `assoc` | Cadastrar novo motoboy |
| `/motoboys/{id}` | PUT | `assoc`/`motoboy` | Atualizar dados de motoboy com ID `{id}` |
| `/motoboys/{id}` | DELETE | `assoc` | Excluir cadastro de motoboy com ID `{id}` |
| `/orders` | GET | `admin`/`assoc`/`motoboy` | Listar dados de todas as entregas |
| `/orders?status={status}` | GET | `admin`/`assoc`/`motoboy` | Listar dados de todas as entregas com status `{status}` |
| `/orders?motoboy={id}` | GET | `admin`/`assoc`/`motoboy` | Listar dados de todas as entregas do motoboy com ID `{id}` |
| `/orders/{id}` | GET | `admin`/`assoc`/`motoboy` | Acessar dados de entrega com ID `{id}` |
| `/orders` | POST | `assoc` | Cadastrar nova entrega |
| `/orders/{id}` | PUT | `assoc`/`motoboy` | Atualizar dados de entrega pendente com ID `{id}` |
| `/orders/{id}` | DELETE | `assoc` | Excluir cadastro de entrega pendente com ID `{id}` |
| `/reports/admin` | GET | `assoc` | ??? Dados para relatório administrativo |
| `/reports/fin` | GET | `assoc`/`motoboy` | ??? Dados para relatório financeiro |
OBS: Apenas os dados pertinentes ao usuário autenticado são acessíveis a ele
### Obter token para acesso aos endpoints
Para autenticar como administrador (perfil `admin`), pastar submeter uma requisição **POST**: para o endpoint específico. O token do admin está definido nas variáveis de ambiente.
```http
POST http://localhost:8081/signin/admin
Content-Type: application/json
{}
```
Para autenticar como **associado** ou **motoboy**, inclua o perfil (*role*) na url e passe as credenciais de um item do banco (a senha padrão gerada pelos seeders é `qwerty123`). Use CNPJ para **associados** e CPF para **motoboy**:
```http
POST http://localhost:8081/signin/assoc
Content-Type: application/json
{
"login": "11222333000144",
"password": "qwerty123"
}
```
```http
POST http://localhost:8081/signin/motoboy
Content-Type: application/json
{
"login": "11122233344",
"password": "qwerty123"
}
```