{"id":21254151,"url":"https://github.com/luc-ribeiro/transactions-api-node","last_synced_at":"2026-04-17T15:02:27.343Z","repository":{"id":237516446,"uuid":"794613384","full_name":"luc-ribeiro/transactions-api-node","owner":"luc-ribeiro","description":"Projeto com o objetivo de criar uma API REST de transações, utilizando tecnologias como Fastify, Knex.js e Vitest.","archived":false,"fork":false,"pushed_at":"2024-05-01T15:31:42.000Z","size":81,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-05-02T10:35:46.901Z","etag":null,"topics":["fastify","knexjs","nodejs","sqlite3","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/luc-ribeiro.png","metadata":{"files":{"readme":"README-PTBR.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-05-01T15:30:46.000Z","updated_at":"2024-05-29T22:37:01.336Z","dependencies_parsed_at":null,"dependency_job_id":"8db850de-f1e4-4ff4-a5a8-0a359f499935","html_url":"https://github.com/luc-ribeiro/transactions-api-node","commit_stats":null,"previous_names":["luc-ribeiro/transactions-api-node"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luc-ribeiro%2Ftransactions-api-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luc-ribeiro%2Ftransactions-api-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luc-ribeiro%2Ftransactions-api-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luc-ribeiro%2Ftransactions-api-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/luc-ribeiro","download_url":"https://codeload.github.com/luc-ribeiro/transactions-api-node/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243690149,"owners_count":20331729,"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":["fastify","knexjs","nodejs","sqlite3","typescript","vitest","zod"],"created_at":"2024-11-21T03:54:25.299Z","updated_at":"2026-04-17T15:02:27.286Z","avatar_url":"https://github.com/luc-ribeiro.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\nTransactions REST API Node.js\n\u003cbr\u003e\n\u003cbr\u003e\n\u003c/h1\u003e\n\n\u003cdiv align=\"right\"\u003e\n  Click \u003ca href=\"https://github.com/luc-ribeiro/transactions-api-node/blob/main/README.md\"\u003ehere\u003c/a\u003e to view the english version.\n\u003c/div\u003e\n\u003cbr\u003e\n\n## 💻 Projeto\nEste projeto foi criado durante o curso de Node.js da Rocketseat.\n\nO projeto consiste na criação de uma API REST, utilizando tecnologias como \u003cstrong\u003eFastify, Knex.js e Vitest\u003c/strong\u003e.\nO objetivo é praticar a criação de APIs com a utilização dessas tecnologias e enfatizar a importância de \u003cstrong\u003etestes automatizados\u003c/strong\u003e.\n\n## 🚀 Tecnologias\n\n- **Node.js** \n- **TypeScript**\n- **Fastify**\n- **Knex.js**\n- **Vitest**\n- **Zod**\n- **SQLite3**\n\n## Endpoints\n\n#### Criando uma nova transação\n\n\u003cdetails\u003e\n \u003csummary\u003e\u003ccode\u003ePOST\u003c/code\u003e \u003ccode\u003e\u003cb\u003e/transactions\u003c/b\u003e\u003c/code\u003e \u003ccode\u003e(cria uma nova transação)\u003c/code\u003e\u003c/summary\u003e\n\n##### Corpo\n\n\u003e | name      |  type     | data type               | description                                                           |\n\u003e |-----------|-----------|-------------------------|-----------------------------------------------------------------------|\n\u003e | title     |  required | string                  | Nome da transação                                                     |\n\u003e | amount    |  required | int                     | Valor da transação                                                    |\n\u003e | type      |  required | string                  | Tipo da transação (\"credit\" ou \"debit\")                               |\n\n##### Respostas\n\n\u003e | http code     | content-type                      | response                                                            |\n\u003e |---------------|-----------------------------------|---------------------------------------------------------------------|\n\u003e | `201`         | `text/plain;charset=UTF-8`        | `Transaction created successfully`                                  |\n\u003e | `400`         | `application/json`                | `{\"code\":\"400\",\"message\":\"Bad Request\"}`                            |\n\u003e | `405`         | `text/html;charset=utf-8`         | None                                                                |\n\n##### Exemplo cURL\n\n\u003e ```javascript\n\u003e  curl -X POST -H \"Content-Type: application/json\" --data @post.json http://localhost:3333/transactions\n\u003e ```\n\n\u003c/details\u003e\n\n### Para os endpoints abaixo, é necessário gerar uma nova transação, para que seja criado um cookie de autenticação e armazenado no dispositivo.\n\n#### Listando transações\n\n\u003cdetails\u003e\n \u003csummary\u003e\u003ccode\u003eGET\u003c/code\u003e \u003ccode\u003e\u003cb\u003e/transactions\u003c/b\u003e\u003c/code\u003e \u003ccode\u003e(retorna todas as transações)\u003c/code\u003e\u003c/summary\u003e\n\n##### Parâmetros\n\nNenhum.\n\n##### Respostas\n\n\u003e | http code     | content-type                      | response                                                            |\n\u003e |---------------|-----------------------------------|---------------------------------------------------------------------|\n\u003e | `200`         | `application/json`                | JSON contendo todas as transações                                   |\n\n##### Exemplo cURL\n\n\u003e ```javascript\n\u003e  curl -X GET -H \"Content-Type: application/json\" http://localhost:3333/transactions\n\u003e ```\n\n\u003c/details\u003e\n\n#### Exibindo uma transação\n\n\u003cdetails\u003e\n \u003csummary\u003e\u003ccode\u003eGET\u003c/code\u003e \u003ccode\u003e\u003cb\u003e/transactions/{id}\u003c/b\u003e\u003c/code\u003e \u003ccode\u003e(exibe uma transação)\u003c/code\u003e\u003c/summary\u003e\n\n##### Parâmetros\n\n\u003e | name      |  type     | data type               | description                                                           |\n\u003e |-----------|-----------|-------------------------|-----------------------------------------------------------------------|\n\u003e | id        |  required | int                     | Identificador único da transação                                      |\n\n##### Respostas\n\n\u003e | http code     | content-type                      | response                                                            |\n\u003e |---------------|-----------------------------------|---------------------------------------------------------------------|\n\u003e | `200`         | `application/json`                | JSON contendo a transação do ID específico                          |\n\n##### Exemplo cURL\n\n\u003e ```javascript\n\u003e  curl -X GET -H \"Content-Type: application/json\" http://localhost:3333/transactions/id\n\u003e ```\n\n\u003c/details\u003e\n\n#### Exibindo o montante das transações (saldo)\n\n\u003cdetails\u003e\n \u003csummary\u003e\u003ccode\u003eGET\u003c/code\u003e \u003ccode\u003e\u003cb\u003e/transactions/summary\u003c/b\u003e\u003c/code\u003e \u003ccode\u003e(exibe um resumo com o montante das transações)\u003c/code\u003e\u003c/summary\u003e\n\n##### Parâmetros\n\nNenhum.\n\n##### Respostas\n\n\u003e | http code     | content-type                      | response                                                            |\n\u003e |---------------|-----------------------------------|---------------------------------------------------------------------|\n\u003e | `200`         | `application/json`                | JSON contendo um objeto com o montante das transações               |\n\n##### Exemplo cURL\n\n\u003e ```javascript\n\u003e  curl -X GET -H \"Content-Type: application/json\" http://localhost:3333/transactions/summary\n\u003e ```\n\n\u003c/details\u003e\n\n\u003cbr\u003e\n\n## :page_facing_up: Como utilizar\n\n- Faça um clone deste repositório:\n\n```sh\n  $ git clone https://github.com/luc-ribeiro/rest-api-node.git\n```\n\n- Instale as dependências:\n\n```sh\n  # com npm\n  $ npm install\n\n  # com yarn\n  $ yarn install\n```\n\n- Crie um arquivo ```.env``` seguindo a estrutura do ```.env.example```\n\n- Rode as migrations:\n\n```sh\n  # com npm\n  $ npm run knex migrate:latest\n\n  # com yarn\n  $ yarn knex migrate:latest\n```\n\n- Execute o comando:\n\n```sh\n  # com npm\n  $ npm run dev\n\n  # com yarn\n  $ yarn dev\n```\n\n- O projeto rodará em `localhost:3333`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluc-ribeiro%2Ftransactions-api-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluc-ribeiro%2Ftransactions-api-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluc-ribeiro%2Ftransactions-api-node/lists"}