{"id":18470272,"url":"https://github.com/caioagiani/api-restful","last_synced_at":"2025-04-08T10:33:09.105Z","repository":{"id":54257736,"uuid":"265458441","full_name":"caioagiani/api-restful","owner":"caioagiani","description":"API RESTful - NoSQL MongoDB, JWT \u0026 Jest","archived":false,"fork":false,"pushed_at":"2021-03-01T05:40:22.000Z","size":113,"stargazers_count":16,"open_issues_count":1,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-23T11:42:07.094Z","etag":null,"topics":["api","crud","express","mongodb","restful-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/caioagiani.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}},"created_at":"2020-05-20T05:11:50.000Z","updated_at":"2023-08-07T05:23:18.000Z","dependencies_parsed_at":"2022-08-13T10:10:47.111Z","dependency_job_id":null,"html_url":"https://github.com/caioagiani/api-restful","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caioagiani%2Fapi-restful","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caioagiani%2Fapi-restful/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caioagiani%2Fapi-restful/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caioagiani%2Fapi-restful/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/caioagiani","download_url":"https://codeload.github.com/caioagiani/api-restful/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247824435,"owners_count":21002271,"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","crud","express","mongodb","restful-api"],"created_at":"2024-11-06T10:13:27.302Z","updated_at":"2025-04-08T10:33:08.728Z","avatar_url":"https://github.com/caioagiani.png","language":"JavaScript","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg width=\"115\" height=\"100%\" src=\"https://swellcom.com/content/wp-content/uploads/2017/09/api.png\" alt=\"API RESTful\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch3 align=\"center\"\u003eAPI RESTful - NoSQL MongoDB\u003c/h3\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \n[![Status](https://img.shields.io/badge/status-active-success.svg)]()\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)\n\n\u003c/div\u003e\n\n## Apresentação:\n\nProjeto BackEnd: API RESTful seguindo conceito **MVC** utilizando Stack **NodeJS**, padronizado o código com **Eslint** e **Prettier**.\n\nPacotes principais: **Express** responsável pela criação de rotas, Middleware **JWT** para persistência do token por 30minutos, mantendo a segurança e credêncial do usuário, ORM **Mongoose** para conexão com banco de dados NoSQL (**MongoDB**) e por fim, **Jest** para realização de tests.\n\nRotas mapeada do arquivo exportado Insominia: `Insomnia.json`\n\n## Requisitos\n\n#### Sign up\n\n- [x] Este endpoint deverá receber um usuário com os seguintes campos: nome,\n      email, senha e uma lista de objetos telefone.\n\n```java\n{\n  \"nome\": \"string\",\n  \"email\": \"string\",\n  \"senha\": \"senha\",\n  \"telefones\": [\n    {\n     \"numero\": \"123456789\",\n     \"ddd\": \"11\"\n    }\n  ]\n}\n```\n\n- [x] Usar status codes de acordo\n- [x] Em caso de sucesso irá retornar um usuário mais os campos:\n\n* **id**: id do usuário (pode ser o próprio gerado pelo banco, porém seria interessante\n  se fosse um GUID\n* **data_criacao**: data da criação do usuário\n* **data_atualizacao**: data da última atualização do usuário\n* **ultimo_login**: data do último login (no caso da criação, será a mesma que a\n  criação)\n* **token**: token de acesso da API (pode ser um GUID ou um JWT)\n\n- [x] Caso o e-mail já exista, deverá retornar erro com a mensagem \"E-mail já\n      existente\".\n- [x] Token deverá ser persistido junto com o usuário\n\n#### Sign in\n\n- [x] Este endpoint irá receber um objeto com e-mail e senha.\n- [x] Caso o e-mail exista e a senha seja a mesma que a senha persistida, retornar\n      igual ao endpoint de `sign_up`.\n- [x] Caso o e-mail não exista, retornar erro com status apropriado mais a mensagem\n      \"Usuário e/ou senha inválidos\"\n- [x] Caso o e-mail exista mas a senha não bata, retornar o status apropriado 401\n      mais a mensagem \"Usuário e/ou senha inválidos\"\n\n#### Buscar usuário\n\n- [x] Chamadas para este endpoint devem conter um header na requisição de\n      Authentication com o valor \"Bearer {token}\" onde {token} é o valor do token\n      passado na criação ou sign in de um usuário.\n- [x] Caso o token não exista, retornar erro com status apropriado com a mensagem\n      \"Não autorizado\".\n- [x] Caso o token exista, buscar o usuário pelo user_id passado no path e comparar\n      se o token no modelo é igual ao token passado no header.\n- [x] Caso não seja o mesmo token, retornar erro com status apropriado e mensagem\n      \"Não autorizado\"\n- [x] Caso seja o mesmo token, verificar se o último login foi a MENOS que 30\n      minutos atrás.\n- [x] Caso não seja a MENOS que 30 minutos atrás, retornar erro com status\n      apropriado com mensagem \"Sessão inválida\".\n- [x] Caso tudo esteja ok, retornar o usuário.\n\n## Instação:\n\n- Variável de ambiente `.env.example`:\n\n```java\nSECRET_JWT=XXX\nMONGO_CONN=mongodb+srv://\u003cuser\u003e:\u003cpass\u003e@cluster0-okpdn.gcp.mongodb.net/api\n```\n\n- Instalar dependências: `yarn install` ou `npm install`\n- Iniciar aplicação em modo de desenvolvimento: `yarn dev:start` ou `npm run dev:start`.\n- Deploy da aplicação: `yarn start`\n- Tests Jest: `yarn test`\n\n## Rotas\n\n**POST** `localhost:3333/user/create`\n\n```java\n{\n   \"name\": \"Caio Agiani\",\n   \"email\": \"caio.agiani14@gmail.com\",\n   \"password\": \"123\",\n   \"telefones\": [\n      {\n\t\"numero\": \"999865802\",\n\t\"ddd\": \"11\"\n      },\n      {\n\t\"numero\": \"999865802\",\n\t\"ddd\": \"11\"\n      }\n   ]\n}\n```\n\n**POST** `localhost:3333/login`\n\n```java\n{\n   \"email\": \"caio.agiani14@gmail.com\",\n   \"password\": \"123\"\n}\n```\n\n**GET** `localhost:3333/user/:user_id`\n\nObservação importante: rota `/user/:user_id` é necessário passsar no **header** o parâmetro **authentication** contendo o Token Bearer coletado na rota `login`\n\n## Test\n\n```javascript\ncaio-agiani in api-restful on  master [!] took 2s ❯ yarn test\nyarn run v1.22.5\n$ jest --setupFiles dotenv/config --detectOpenHandles --forceExit\n PASS  tests/api.test.js\n  Authentication\n    ✓ should create session authentication (1233 ms)\n  Login\n    ✓ should create user session (131 ms)\n  User\n    ✓ should list user by id (9 ms)\n\nTest Suites: 1 passed, 1 total\nTests:       3 passed, 3 total\nSnapshots:   0 total\nTime:        2.136 s\nRan all test suites.\nDone in 2.58s.\n```\n\n## Contato\n\n- [LinkedIn](https://www.linkedin.com/in/caioagiani/)\n- caio.agiani14@gmail.com\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaioagiani%2Fapi-restful","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcaioagiani%2Fapi-restful","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaioagiani%2Fapi-restful/lists"}