{"id":22242255,"url":"https://github.com/lasbrdev/backend-node-programacao-2","last_synced_at":"2026-04-12T00:46:18.053Z","repository":{"id":265978963,"uuid":"897023804","full_name":"lasbrDev/backend-node-programacao-2","owner":"lasbrDev","description":"REST API desenvolvida durante o semestre para explorar o backend com Node.js. Proposta da disciplina de Programação II do curso de Engenharia de Software da Unoeste.","archived":false,"fork":false,"pushed_at":"2024-12-01T21:49:36.000Z","size":33,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-30T09:41:48.975Z","etag":null,"topics":["api-rest","backend","docker","mysql","nodejs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lasbrDev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-01T21:40:13.000Z","updated_at":"2024-12-25T01:00:12.000Z","dependencies_parsed_at":"2024-12-02T02:32:42.635Z","dependency_job_id":null,"html_url":"https://github.com/lasbrDev/backend-node-programacao-2","commit_stats":null,"previous_names":["lasbrdev/backend-node-programacao-2"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lasbrDev%2Fbackend-node-programacao-2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lasbrDev%2Fbackend-node-programacao-2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lasbrDev%2Fbackend-node-programacao-2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lasbrDev%2Fbackend-node-programacao-2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lasbrDev","download_url":"https://codeload.github.com/lasbrDev/backend-node-programacao-2/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245442544,"owners_count":20616039,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-rest","backend","docker","mysql","nodejs"],"created_at":"2024-12-03T04:15:13.061Z","updated_at":"2026-04-12T00:46:18.001Z","avatar_url":"https://github.com/lasbrDev.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# API REST Backend Node.js - Atividade Programação II\n\nEste projeto foi desenvolvido durante as disciplinas de Programação I e II do curso de Engenharia de Software da Unoeste. A proposta era criar separadamente um frontend e um backend e, ao final, integrar ambos.\n\n## Funcionalidades\n\nEsta API fornece endpoints para gerenciar clientes, fornecedores e produtos. As principais funcionalidades incluem:\n\n- **Clientes**:\n  - Cadastro de clientes\n  - Consulta de clientes\n  - Atualização de clientes (total e parcial)\n  - Exclusão de clientes\n\n- **Fornecedores**:\n  - Cadastro de fornecedores\n  - Consulta de fornecedores\n  - Atualização de fornecedores (total e parcial)\n  - Exclusão de fornecedores\n\n- **Produtos**:\n  - Cadastro de produtos\n  - Consulta de produtos\n  - Atualização de produtos (total e parcial)\n  - Exclusão de produtos\n\n## Endpoints\n\n### Clientes\n- `POST /api/clientes`: Cadastrar um novo cliente\n- `GET /api/clientes`: Consultar todos os clientes\n- `PUT /api/clientes/:id`: Atualizar um cliente\n- `PATCH /api/clientes/:id`: Atualizar parcialmente um cliente\n- `DELETE /api/clientes/:id`: Excluir um cliente\n\n### Fornecedores\n- `POST /api/fornecedores`: Cadastrar um novo fornecedor\n- `GET /api/fornecedores`: Consultar todos os fornecedores\n- `PUT /api/fornecedores/:id`: Atualizar um fornecedor\n- `PATCH /api/fornecedores/:id`: Atualizar parcialmente um fornecedor\n- `DELETE /api/fornecedores/:id`: Excluir um fornecedor\n\n### Produtos\n- `POST /api/produtos`: Cadastrar um novo produto\n- `GET /api/produtos`: Consultar todos os produtos\n- `PUT /api/produtos/:id`: Atualizar um produto\n- `PATCH /api/produtos/:id`: Atualizar parcialmente um produto\n- `DELETE /api/produtos/:id`: Excluir um produto\n\n## Tecnologias Utilizadas\n\n### Bibliotecas Principais\n\n- **Express**: Framework para construção de APIs REST.\n- **Sequelize**: ORM para interação com o banco de dados.\n- **dotenv**: Carregar variáveis de ambiente a partir de um arquivo `.env`.\n- **express-validator**: Middleware para validação de dados.\n- **cors**: Middleware para habilitar CORS (Cross-Origin Resource Sharing).\n\n### Banco de Dados\n\n- **MySQL**: Banco de dados relacional utilizado para armazenar os dados da aplicação.\n\n## Diagramas do Projeto\n\n### Diagrama de Classes\n\n```mermaid\nclassDiagram\n    class App {\n    }\n\n    class ClienteController {\n        +cadastrarCliente(req, res)\n        +consultarClientes(req, res)\n        +atualizarCliente(req, res)\n        +atualizarClienteParcial(req, res)\n        +excluirCliente(req, res)\n    }\n\n    class FornecedorController {\n        +cadastrarFornecedor(req, res)\n        +consultarFornecedores(req, res)\n        +atualizarFornecedor(req, res)\n        +atualizarFornecedorParcial(req, res)\n        +excluirFornecedor(req, res)\n    }\n\n    class ProdutoController {\n        +cadastrarProduto(req, res)\n        +consultarProdutos(req, res)\n        +atualizarProduto(req, res)\n        +atualizarProdutoParcial(req, res)\n        +excluirProduto(req, res)\n    }\n\n    class ClienteRoutes {\n        +post(\"/\")\n        +get(\"/\")\n        +put(\"/:id\")\n        +patch(\"/:id\")\n        +delete(\"/:id\")\n    }\n\n    class FornecedorRoutes {\n        +post(\"/\")\n        +get(\"/\")\n        +put(\"/:id\")\n        +patch(\"/:id\")\n        +delete(\"/:id\")\n    }\n\n    class ProdutoRoutes {\n        +post(\"/\")\n        +get(\"/\")\n        +put(\"/:id\")\n        +patch(\"/:id\")\n        +delete(\"/:id\")\n    }\n\n    class Cliente {\n        -id: INTEGER\n        -cpf: STRING\n        -nomeCompleto: STRING\n        -endereco: STRING\n        -cidade: STRING\n        -estado: STRING\n        -cep: STRING\n    }\n\n    class Fornecedor {\n        -id: INTEGER\n        -cnpj: STRING\n        -razaoSocial: STRING\n        -telefone: STRING\n        -email: STRING\n        -endereco: STRING\n    }\n\n    class Produto {\n        -id: INTEGER\n        -codigo: STRING\n        -nome: STRING\n        -descricao: STRING\n        -preco: FLOAT\n        -categoria: STRING\n        -estoque: INTEGER\n    }\n\n    App --\u003e ClienteRoutes\n    App --\u003e FornecedorRoutes\n    App --\u003e ProdutoRoutes\n\n    ClienteRoutes --\u003e ClienteController\n    FornecedorRoutes --\u003e FornecedorController\n    ProdutoRoutes --\u003e ProdutoController\n\n    ClienteController --\u003e Cliente\n    FornecedorController --\u003e Fornecedor\n    ProdutoController --\u003e Produto\n\n```\n\n### Diagrama de Sequência - Cliente case\n\n```mermaid\nsequenceDiagram\n    actor User\n\n    User-\u003e\u003eApp: Request to /api/clientes (POST)\n    App-\u003e\u003eClienteRoutes: Route request\n    ClienteRoutes-\u003e\u003eClienteController: Call cadastrarCliente\n    ClienteController-\u003e\u003eCliente: Create new Cliente\n    Cliente-\u003e\u003eDatabase: Save Cliente\n    Database--\u003e\u003eCliente: Return saved Cliente\n    Cliente--\u003e\u003eClienteController: Return saved Cliente\n    ClienteController--\u003e\u003eClienteRoutes: Return response\n    ClienteRoutes--\u003e\u003eApp: Return response\n    App--\u003e\u003eUser: Return response (201 Created)\n\n```\n\n### Diagrama de Camada de Apresentação\n\n```mermaid\nclassDiagram\n    direction LR\n\n    class database {\n        \u003c\u003cDatabase\u003e\u003e\n        Database (Sequelize)\n    }\n\n    class index {\n        \u003c\u003cComponent\u003e\u003e\n        Index.js\n    }\n\n    class authMiddleware {\n        \u003c\u003cMiddleware\u003e\u003e\n        Authentication.js\n    }\n    \n    class loginVerification {\n        \u003c\u003cMiddleware\u003e\u003e\n        LoginVerification.js\n    }\n\n    class clienteValidator {\n        \u003c\u003cValidator\u003e\u003e\n        ClienteValidator.js\n    }\n\n    class clienteRoutes {\n        \u003c\u003cRoutes\u003e\u003e\n        ClienteRoutes.js\n    }\n\n    class clienteController {\n        \u003c\u003cController\u003e\u003e\n        ClienteController.js\n    }\n\n    class clienteModel {\n        \u003c\u003cModel\u003e\u003e\n        Cliente.js\n    }\n\n    %% Repeat similar classes for Fornecedor and Produto\n    class fornecedorValidator {\n        \u003c\u003cValidator\u003e\u003e\n        FornecedorValidator.js\n    }\n    class produtoValidator {\n        \u003c\u003cValidator\u003e\u003e\n        ProdutoValidator.js\n    }\n    %% ... (other classes omitted for brevity)\n\n    %% Server connections\n    index --\u003e clienteRoutes\n    index --\u003e fornecedorRoutes\n    index --\u003e produtoRoutes\n\n    %% Routes to controllers\n    clienteRoutes --\u003e clienteController\n    fornecedorRoutes --\u003e fornecedorController\n    produtoRoutes --\u003e produtoController\n\n    %% Controllers to models\n    clienteController --\u003e clienteModel\n    fornecedorController --\u003e fornecedorModel\n    produtoController --\u003e produtoModel\n\n    %% Models to database\n    clienteModel --\u003e database\n    fornecedorModel --\u003e database\n    produtoModel --\u003e database\n\n    %% Middleware applied to routes\n    clienteRoutes ..\u003e authMiddleware: uses\n    fornecedorRoutes ..\u003e authMiddleware: uses\n    produtoRoutes ..\u003e authMiddleware: uses\n\n    %% Validations before controllers\n    clienteRoutes ..\u003e clienteValidator: validates with\n    fornecedorRoutes ..\u003e fornecedorValidator: validates with\n    produtoRoutes ..\u003e produtoValidator: validates with\n```\n\n\n\n## Configuração do Projeto\n\n1. Clone o repositório:\n   ```sh\n   git clone https://github.com/lasbrDev/backend-node-programacao-2.git\n    ```\n2. Instale as dependências\n```bash \nnpm install\n```\n3. Configure as variáveis de ambiente no arquivo *.env*:\n```bash\nDB_NAME=\u003cnome_do_banco_de_dados\u003e\nDB_USER=\u003cusuario_do_banco_de_dados\u003e\nDB_PASSWORD=\u003csenha_do_banco_de_dados\u003e\nDB_HOST=\u003chost_do_banco_de_dados\u003e\nDB_PORT=\u003cporta_do_banco_de_dados\u003e\nAPP_PORT=\u003cporta_da_aplicacao\u003e\n```\n4. Inicie a aplicação\n\n```bash\nnpm start\n```\n\n## Licença\n\nEste projeto está licenciado sob a [MIT LICENSE](LICENSE).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flasbrdev%2Fbackend-node-programacao-2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flasbrdev%2Fbackend-node-programacao-2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flasbrdev%2Fbackend-node-programacao-2/lists"}