{"id":18135374,"url":"https://github.com/santiagomorais/daily-diet---node-restful-api","last_synced_at":"2026-02-09T08:06:49.436Z","repository":{"id":259308711,"uuid":"877528449","full_name":"SantiagoMorais/Daily-Diet---Node-Restful-API","owner":"SantiagoMorais","description":"API Node to login users and register meals","archived":false,"fork":false,"pushed_at":"2024-11-12T18:44:34.000Z","size":271,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-03T13:22:39.947Z","etag":null,"topics":["fastify","knex","nodejs","supertest","typescript","vitest","zod"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/SantiagoMorais.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-10-23T20:03:09.000Z","updated_at":"2024-11-12T18:44:38.000Z","dependencies_parsed_at":"2024-10-24T08:47:12.858Z","dependency_job_id":"341cbd34-1a0a-4a27-a2fd-39ab116389fd","html_url":"https://github.com/SantiagoMorais/Daily-Diet---Node-Restful-API","commit_stats":null,"previous_names":["santiagomorais/daily-diet---node-restful-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/SantiagoMorais/Daily-Diet---Node-Restful-API","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SantiagoMorais%2FDaily-Diet---Node-Restful-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SantiagoMorais%2FDaily-Diet---Node-Restful-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SantiagoMorais%2FDaily-Diet---Node-Restful-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SantiagoMorais%2FDaily-Diet---Node-Restful-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SantiagoMorais","download_url":"https://codeload.github.com/SantiagoMorais/Daily-Diet---Node-Restful-API/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SantiagoMorais%2FDaily-Diet---Node-Restful-API/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267116322,"owners_count":24038623,"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","status":"online","status_checked_at":"2025-07-26T02:00:08.937Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["fastify","knex","nodejs","supertest","typescript","vitest","zod"],"created_at":"2024-11-01T14:06:59.946Z","updated_at":"2026-02-09T08:06:49.402Z","avatar_url":"https://github.com/SantiagoMorais.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Daily Diet - Node Restful API\n\n![banner](src/assets/imgs/banner.png)\n\n## Sumário\n\n- [Bibliotecas](#bibliotecas)\n  - [Dependências](#dependencias)\n  - [Dependências de desenvolvimento](#dependencias-de-desenvolvimento)\n- [Requisitos da aplicação](#requisitos-da-aplicacao)\n- [Funcionalidade](#funcionalidade)\n- [Rotas](#rotas)\n  - [POST - Criar usuário](#post---criar-usuário)\n  - [POST - Login](#post---login)\n  - [GET - Visualizar os dados pessoais](#get---visualizar-os-dados-pessoais)\n  - [POST - Registrar nova refeição](#post---registrar-nova-refeição)\n  - [PUT - Editar os dados de uma refeição](#put---editar-os-dados-de-uma-refeição)\n  - [DELETE - Deletar uma refeição](#delete---deletar-uma-refeição)\n  - [GET - Listar refeições](#get---listar-refeições)\n  - [GET - Visualizar uma refeição](#get---visualizar-uma-refeição)\n  - [GET - User Summary](#get---user-summary)\n- [Como rodar o projeto](#como-rodar-o-projeto)\n- [Autor](#autor)\n\n## Bibliotecas\n\n### Dependências\n\n- [Fastify](https://fastify.dev): Framework web para Node.js usado para criar APIs e servidores HTTP (similar ao Express.js) e possio suporte à tipagem TypeScript.\n\n- [Knex](https://knexjs.org): **SQL query builder** utilizado para simplificar a linguagem sql. É um construtor de queries, que facilita a escrita do código usando javascript. Similar a um ORM.\n\n- [dotenv](https://www.npmjs.com/package/dotenv): Dotenv carrega variáveis ambiente de um arquivo .env ao `process.env` em aplicações Node.js.\n\n- [zod](https://zod.dev/): Biblioteca de validação de esquemas e dados, garantindo a segurança dos dados.\n\n- [Fastify-type-provider-zod](https://github.com/turkerdev/fastify-type-provider-zod): Integra o **Zod** com o **Fastify**, permitindo validar e tipar dados das requisições HTTP para evitar erros. Usa validações do Zod para definir e validar o `body`, `params`, `query` e `headers` das requisições.\n\n- [@fastify/cookie](https://github.com/fastify/fastify-cookie): Um plugin para o Fastify que adiciona suporte para ler e definir cookies.\n\n- [pg](https://node-postgres.com): Driver do banco de dados do PostgreSQL.\n\n- [@fastify/cors](https://github.com/fastify/fastify-cors): Plugin do Fastify que configura o CORS (Cross-Origin Resource Sharing), uma medida de segurança que limita o acesso ao backend, permitindo apenas frontends específicos.\n\n### Dependências de desenvolvimento\n\n- [ESLint](https://eslint.org/): Ferramenta para análise de código, responsável por identificar erros e inconsistências, como variáveis não utilizadas ou não declaradas.\n\n- [Prettier](https://prettier.io/): Ferramenta de formatação de código como indentação, espaçamento, uso de aspas simples ou duplas, etc, garantindo consistência no estilo do código.\n\n- [Vitest](https://vitest.dev): Um framework de test nativo do vite, mas mais rápido que Jest. Apesar disso, a migração do Jest ao Vitest é simples, pois a sintaxe é extremamente similar.\n\n- [tsx](https://tsx.is): TSX significa _Typescript Execute_, servindo como um executor node para rodar código Typescript.\n\n- [Supertest](https://www.npmjs.com/package/supertest): A motivação com este módulo é fornecer uma abstração de alto nível para testar HTTP, ao mesmo tempo que permite acessar a API de nível inferior fornecida pelo `superagent`. Ou seja, testar o servidor sem precisar rodá-lo em uma porta específica, evitando conflitos.\n\n- [tsup](https://tsup.egoist.dev): Ferramenta para otimizar projetos TypeScript, permitindo realizar o build (converter TS em JS) de forma eficiente. Além disso, assim como Vitest e TSX, ele utiliza o **esbuild**, que acelera processos e facilita o desenvolvimento com TypeScript de maneira moderna.\n\n## Requisitos da aplicação\n\n- [x] Deve ser possível criar um usuário\n\n  - name\n  - email\n  - user_id\n  - password\n  - repeat_password\n  - session_id\n\n- [x] Deve ser possível identificar o usuário entre as requisições\n- [x] Deve ser possível registrar uma refeição feita, com as seguintes informações: _As refeições devem ser relacionadas a um usuário._\n\n  - meal_id\n  - user_id\n  - title\n  - description\n  - in_the_diet (Está dentro ou não da dieta)\n  - created_at (Data e hora)\n  - updated_at\n\n- [x] Deve ser possível listar todas as refeições de um usuário\n- [x] Deve ser possível editar uma refeição, podendo alterar todos os dados acima\n- [x] Deve ser possível apagar uma refeição\n- [x] Deve ser possível visualizar uma única refeição\n- [x] Deve ser possível recuperar as métricas de um usuário\n\n  - Quantidade total de refeições registradas\n  - Quantidade total de refeições dentro da dieta\n  - Quantidade total de refeições fora da dieta\n  - Melhor sequência de refeições dentro da dieta\n\n- [x] O usuário só pode visualizar, editar e apagar as refeições o qual ele criou\n\n## Rotas\n\n### POST - Criar usuário\n\n- Rota: `\"/users\"`\n- Método: `POST`\n- Objetivo: Criar novo usuário\n\n```ts\n// Criptografando a senha antes de adicioná-la ao banco.\nconst salt = await bcrypt.genSalt(12);\nconst passwordHash = await bcrypt.hash(password, salt);\n\n// O session_id por enquanto não é definido e só será durante a realização do login.\nawait knex\u003cIUser\u003e(\"users\").insert({\n  email,\n  name,\n  password: passwordHash,\n  user_id: randomUUID(),\n});\n```\n\n### POST - Login\n\n- Rota: `\"/login\"`\n- Método: `POST`\n- Objetivo: Realizar o login do usuário para que possa cadastrar refeições\n\nUtilizado sistema de login para atenticar usuários.\nAtualizando o `session_id` para um `id` válido e o enviando para os `cookies` através do [@fastify/cookie](https://github.com/fastify/fastify-cookie).\n\n```ts\nlet sessionId = req.cookies.session_id;\n\nif (!sessionId) {\n  sessionId = randomUUID();\n\n  res.cookie(\"session_id\", sessionId, {\n    path: \"/\",\n    maxAge: 60 * 60 * 24, // 1 day - O maxAge define em segundos a duração do cookie.\n  });\n}\n\nawait knex\u003cIUser\u003e(\"users\").select().where(\"email\", email).update({\n  session_id: sessionId,\n});\n```\n\n### GET - Visualizar os dados pessoais\n\n- Rota: `\"/users/profile\"`\n- Método: `GET`\n- Objetivo: Permitir ao usuário visualizar seu nome e email cadastrados\n\nA partir daqui todas as rotas verificam a presença da `session_id` nos cookies para permitir que o usuário crie, delete ou edite informações.\n\nMiddleware para verificação da existência de um `session_id`:\n\n```ts\n  const sessionId = req.cookies.session_id;\n\n  if (!sessionId) return res.status(401).send({ message: \"Unauthorized\" });\n\n  done();\n};\n```\n\nFunção que avalia se o `session_id` atual nos cookies bate com o registrado nos dados do usuário no banco.\n\n```ts\nconst sessionId = req.cookies.session_id;\n\nconst userLogged = await knex\u003cIUser\u003e(\"users\")\n  .where({\n    session_id: sessionId,\n  })\n  .first();\n\nif (!userLogged) return res.status(401).send({ message: \"Unauthorized\" });\n```\n\nDando tudo correto, o usuário pode visualizar os seus dados.\n\n```ts\nconst sessionId = req.cookies.session_id;\n\nif (!sessionId) return res.status(401).send({ message: \"Unauthorized!\" });\n\nconst userData = await knex\u003cIUser\u003e(\"users\")\n  .select(\"email\", \"name\")\n  .where({ session_id: sessionId })\n  .first();\n\nif (!userData) return res.status(404).send({ message: \"User not found!\" });\n\nreturn res.status(200).send({ user: userData });\n```\n\n### POST - Registrar nova refeição\n\n- Rota: `\"/meals\"`\n- Método: `POST`\n- Objetivo: Criar nova refeição feita\n\n```ts\nawait knex\u003cIMeal\u003e(\"meals\").insert({\n  user_id: user?.user_id,\n  meal_id: randomUUID(),\n  title,\n  description,\n  in_the_diet: inTheDiet,\n  created_at: currentDate,\n});\n```\n\n### PUT - Editar os dados de uma refeição\n\n- Rota: `\"/meals/:meal_id\"`\n- Método: `PUT`\n- Objetivo: Editar os dados de uma refeição\n\nPara que o usuário tenha permissão para alterar um dado, precisamos verificar se a refeição registrada possui o id do usuário logado. Dessa forma evitamos que outros usuários editem dados que não são seus.\n\n```ts\nconst userCanEditMeal = await knex\u003cIMeal\u003e(\"meals\")\n  .where({\n    meal_id: mealId,\n  })\n  .andWhere({ user_id: userLogged.user_id })\n  .first();\n\nif (!userCanEditMeal) return res.status(401).send({ message: \"Unauthorized\" });\n```\n\nAs permissões sendo totalmente autorizadas, o usuário pode atualizar os dados e o campo `updated_at` é atualizado para a data atual:\n\n```ts\nconst currentDate = new Date().toLocaleString(\"pt-BR\");\n\nawait knex\u003cIMeal\u003e(\"meals\")\n  .where({ meal_id: mealId })\n  .update({ updated_at: currentDate, ...updates });\n```\n\n### DELETE - Deletar uma refeição\n\n- Rota: `\"/meals/:meal_id\"`\n- Método: `DELETE`\n- Objetivo: Deletar uma refeição\n\nApós todas as verificações demonstradas anteriormente e o usuário tendo permissão de deletar uma refeição, ela é removida do banco de dados, com uma requisição simples ao banco de dados:\n\n```ts\nexport const deleteMeal = async ({ res, mealId }: IDeleteMeal) =\u003e {\n  await knex\u003cIMeal\u003e(\"meals\").where({ meal_id: mealId }).delete();\n\n  return res.status(204).send();\n};\n```\n\n### GET - Listar refeições\n\n- Rota: `\"/meals\"`\n- Método: `GET`\n- Objetivo: Listar todas as refeições de um usuário\n\n```ts\nconst meals = await knex\u003cIMeal\u003e(\"meals\")\n  .where({ user_id: userLogged.user_id })\n  .select(\n    \"title\",\n    \"description\",\n    \"in_the_diet\",\n    \"created_at\",\n    \"updated_at\",\n    \"meal_id\"\n  );\n```\n\n### GET - Visualizar uma refeição\n\n- Rota: `\"/meals/meal_id\"`\n- Método: `GET`\n- Objetivo: Listar uma refeição específica de um usuário pelo id\n\n```ts\nconst { user_id, ...rest }: IMeal = validMeal; // removing user_id\nconst meal = { ...rest, in_the_diet: 1 ? true : false }; // changing the return of in_the_diet to true or false instead of 1 or 0\n\nreturn res.status(200).send({ meal });\n```\n\nO banco de dados registra dados como `true` ou `false` como 1 e 0, respectivamente. Assim só foi necessário mudar isso antes de ser enviado como resposta ao Frontend.\n\n### GET - User Summary\n\n- Rota: `\"/summary\"`\n- Método: `GET`\n- Objetivo: Listar um resumo do usuário, incluindo:\n  - Quantidade total de refeições registradas\n  - Quantidade total de refeições dentro da dieta\n  - Quantidade total de refeições fora da dieta\n  - Melhor sequência de refeições dentro da dieta\n\nEssa última rota exigiu um pouco mais de lógica.\n\n- **Quantidade total de refeições dentro e fora da dieta**: As refeições nos retornam a informação `in_the_diet` que pode ser `true` ou `false`. Assim só precisamos utilizar o método `filter` para verificar quais estão dentro ou fora da dieta.\n\n```ts\nconst { user_id }: IUser = user;\n\nconst mealsData = await knex\u003cIMeal\u003e(\"meals\").select().where({\n  user_id,\n});\n\nconst mealsInTheDiet = mealsData.filter((meal) =\u003e meal.in_the_diet).length;\nconst mealsOutTheDiet = mealsData.filter((meal) =\u003e !meal.in_the_diet).length;\n```\n\n- **Melhor sequência de refeições dentro da dieta**: Aqui precisamos avaliar quantas refeições dentro da dieta o usuário teve em sequência. Utilizando o método `map()` conseguimos percorrer todas as refeições na ordem de registro ao banco de dados. Assim, foi utilizado esta função para registrar a sequência:\n\n```ts\nconst bestDietSequency = (): number =\u003e {\n  let bestSequency = 0; // A melhor sequência\n  let currentSequency = 0; // A sequência atual percorrida pelo método map\n\n  mealsData.map((meal) =\u003e {\n    if (meal.in_the_diet) {\n      currentSequency++; // Quando a refeição atual está dentro da dieta, a sequência atual aumenta\n      if (currentSequency \u003e bestSequency) bestSequency = currentSequency; // Se a melhor sequência é menor que a atual, a melhor é atualizada\n    } else if (!meal.in_the_diet) {\n      currentSequency = 0; // Se a refeição atual está fora da dieta, a sequência atual é resetada e reinicia do zero.\n    }\n  });\n  return bestSequency; // Após percorrermos por todas as refeições do usuário, é retornado a melhor sequência.\n};\n```\n\n```json\n{\n  \"summary\": {\n    \"mealsRegistered\": 3,\n    \"mealsInTheDiet\": 2,\n    \"mealsOutTheDiet\": 1,\n    \"bestDietSequency\": 2\n  }\n}\n```\n\n- **Quantidade total de refeições registradas**: Só precisamos coletar todas as refeições registradas com o id do usuário e coletar a `lenght`.\n\nResultado:\n\n```ts\nconst summary = {\n  mealsRegistered: mealsData.length,\n  mealsInTheDiet,\n  mealsOutTheDiet,\n  bestDietSequency: bestDietSequency(),\n};\n\nreturn res.status(200).send({ summary });\n```\n\n## Como rodar o projeto\n\n- Instalar as dependências `npm install`\n- Criar o arquivo `.env` e `.env.test` caso queira realizar os testes `e2e` da aplicação. Configure as variáveis ambiente como demonstra o arquivo `.env.example` e `.env.test.example`.\n- Executar as migrations `npm run knex migrate:latest`\n- Executar o servidor `npm run server`\n\n## Autor\n\n- GitHub - [Felipe Santiago Morais](https://github.com/SantiagoMorais)\n- Linkedin - [Felipe Santiago](https://www.linkedin.com/in/felipe-santiago-873025288/)\n- Instagram - [@felipe.santiago.morais](https://www.instagram.com/felipe.santiago.morais)\n- Email - \u003ca href=\"mailto:contatofelipesantiago@gmail.com\" target=\"blank\"\u003econtatofelipesantiago@gmail.com\u003c/a\u003e\n- \u003ca href=\"https://api.whatsapp.com/send?phone=5531996951033\u0026text=Hi%2C%20Felipe%21%20I%20got%20your%20contact%20from%20your%20portfolio.\"\u003eWhatsapp\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsantiagomorais%2Fdaily-diet---node-restful-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsantiagomorais%2Fdaily-diet---node-restful-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsantiagomorais%2Fdaily-diet---node-restful-api/lists"}