{"id":20366464,"url":"https://github.com/igorcarmona-git/api-igor","last_synced_at":"2025-03-04T19:27:56.470Z","repository":{"id":244586983,"uuid":"810580353","full_name":"igorcarmona-git/api-igor","owner":"igorcarmona-git","description":"Trabalho academico, uma API Rest construída com express, sequelize-cli, postgree, cors, dotenv, jsonwebtoken, bcrypt e multer (upload de arquivos)","archived":false,"fork":false,"pushed_at":"2024-06-21T19:27:40.000Z","size":9496,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-15T05:37:39.736Z","etag":null,"topics":["api-rest","app-backend","backend","criptography","javascript","json-api"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/igorcarmona-git.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-06-05T01:19:15.000Z","updated_at":"2024-08-09T02:29:28.000Z","dependencies_parsed_at":"2024-11-15T00:27:40.399Z","dependency_job_id":"c419a1ee-abf7-49f7-bca8-a7ea80a24403","html_url":"https://github.com/igorcarmona-git/api-igor","commit_stats":null,"previous_names":["igorcarmona-git/api-igor"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igorcarmona-git%2Fapi-igor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igorcarmona-git%2Fapi-igor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igorcarmona-git%2Fapi-igor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igorcarmona-git%2Fapi-igor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/igorcarmona-git","download_url":"https://codeload.github.com/igorcarmona-git/api-igor/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241908216,"owners_count":20040598,"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","app-backend","backend","criptography","javascript","json-api"],"created_at":"2024-11-15T00:24:57.477Z","updated_at":"2025-03-04T19:27:56.415Z","avatar_url":"https://github.com/igorcarmona-git.png","language":"JavaScript","readme":"# API REST para CRUD de Pessoas\r\n\r\nEste é um trabalho acadêmico desenvolvido para a disciplina de Desenvolvimento Web. A API foi construída utilizando Node.js, Nodemon, Express, Sequelize ORM, Postgree (como banco de dados), dotenv, cors, jsonwebtoken, bcrypt, multer.\r\n\r\n## Funcionalidades\r\n\r\n- **CRUD**: A API oferece operações CRUD (Criar, Ler, Atualizar, Deletar) com validações baseadas nos dados fornecidos nas requisições HTTP.\r\n- **Autenticação criptografada**: Foi utilizado \"bcrypt\" para criptografar dados além de utilizar bearer tokens para rotas autenticadas.\r\n- **Consistência de Dados**: Utilizamos o postgree via cloud no Render para garantir a consistência e persistência dos dados.\r\n\r\n### Endpoints\r\n**Users**:\r\n- `GET /users`: Retorna a lista de todos os usuários armazenadas no banco de dados. *(Autenticada)*\r\n- `GET /users/:username`: Retorna os dados do usuário fornecido. *(Autenticada)*\r\n- `GET /users/allactive`: Retorna todos os usuários ativos. *(Autenticada)*\r\n- `GET /users/allinactive`: Retorna todos os usuários inativos. *(Autenticada)*\r\n- `POST /users`: Permite criar uma nova entrada no banco de dados com os dados fornecidos para um usuário. \r\n- `PUT /users/:username`: Permite editar os detalhes de uma pessoa com base no CPF fornecido. *(Autenticada)*\r\n- `DELETE /users/:username`: Permite excluir uma entrada do banco de dados com base no usuário fornecido. *(Autenticada)*\r\n\r\n**Profile**:\r\n- `GET /profiles/:username`: Retorna os dados do perfil do usuário fornecido. *(Autenticada)*\r\n- `POST /profiles/:username`: Permite criar os dados do perfil do usuário fornecido. *(Autenticada)*\r\n- `PUT /profiles/:username`: Permite editar os dados do perfil do usuário fornecido. *(Autenticada)*\r\n\r\n**Login**:\r\n- `POST /login`: Rota para realização do login na aplicação, te retorna um BEARER Token.\r\n\r\n**Reports**:\r\n- `GET /reports/findAllDataByUser/:username`: Permite visualizar todos os dados de perfil e de usuário, de um usuário fornecido. *(Autenticada)*\r\n\r\n#### Corpo da Requisição (HTTP BODY)\r\n**Users**\r\n- Deve-se fazer o login e passar o token em authorization.\r\n```json\r\n{\r\n  \"username\": \"igorcarmona\",\r\n  \"email\": \"igorcarmonawork@gmail.com\",\r\n  \"password\": \"Senha-Qualquer@123\",\r\n  \"cpf\": \"19692736075\",\r\n  \"status\": \"active\"\r\n}\r\n```\r\n\r\n**Login**\r\n```json\r\n{\r\n  \"username\": \"igorcarmona\",\r\n  \"password\": \"Senha-Qualquer@123\",\r\n}\r\n```\r\n\r\n**Profile**\r\n```json\r\n{\r\n  \"bio\": \"Uma pessoa bastante divertida!\",\r\n  \"birthdate\": \"2000-05-25\",\r\n  \"city\": \"Cianorte\",\r\n  \"state\": \"pr\",\r\n}\r\n```\r\n\r\n## Pré-requisitos\r\n\r\nCertifique-se de ter o ambiente de desenvolvimento Node.js configurado em sua máquina. Você pode seguir a [documentação oficial do Node.js](https://nodejs.org/en) para configurar o ambiente.\r\n\r\n## Instalação\r\n\r\nPara instalar e configurar o projeto localmente, siga estas etapas:\r\n\r\n1. Clone o repositório:\r\n\r\n```bash\r\ngit clone https://github.com/igorcarmona-git/trabalho-api.git\r\ncd trabalho-api\r\n```\r\n\r\n2. Instale as dependências:\r\n   \r\n```bash\r\nnpm install\r\n```\r\nou \r\n```bash\r\nyarn install\r\n```\r\n\r\n## Uso\r\n1. Inicie a API na raiz da pasta do projeto.\r\n\r\n```bash\r\nnpm start\r\n```\r\n\r\n## Contribuição\r\nContribuições são bem-vindas! Sinta-se à vontade para abrir issues ou pull requests para melhorar o projeto.\r\n\r\n**Para mais informações, entrar em contato via redes sociais.**\r\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figorcarmona-git%2Fapi-igor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Figorcarmona-git%2Fapi-igor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figorcarmona-git%2Fapi-igor/lists"}