{"id":27288393,"url":"https://github.com/geovaneborba/ftr-pos-api-docs","last_synced_at":"2026-04-04T22:34:02.433Z","repository":{"id":287409330,"uuid":"964630991","full_name":"geovaneborba/ftr-pos-api-docs","owner":"geovaneborba","description":"Documentação de APIs com Swagger","archived":false,"fork":false,"pushed_at":"2025-04-11T14:38:55.000Z","size":18,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-11T20:48:57.500Z","etag":null,"topics":["api-documentation","fastify","node","openapi-specification","scalar","swagger","typescript","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/geovaneborba.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,"zenodo":null}},"created_at":"2025-04-11T14:22:51.000Z","updated_at":"2025-04-11T15:42:19.000Z","dependencies_parsed_at":"2025-04-11T16:02:07.307Z","dependency_job_id":null,"html_url":"https://github.com/geovaneborba/ftr-pos-api-docs","commit_stats":null,"previous_names":["geovaneborba/ftr-pos-api-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/geovaneborba/ftr-pos-api-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geovaneborba%2Fftr-pos-api-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geovaneborba%2Fftr-pos-api-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geovaneborba%2Fftr-pos-api-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geovaneborba%2Fftr-pos-api-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/geovaneborba","download_url":"https://codeload.github.com/geovaneborba/ftr-pos-api-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geovaneborba%2Fftr-pos-api-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31416776,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-04T20:09:54.854Z","status":"ssl_error","status_checked_at":"2026-04-04T20:09:44.350Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["api-documentation","fastify","node","openapi-specification","scalar","swagger","typescript","zod"],"created_at":"2025-04-11T20:46:24.591Z","updated_at":"2026-04-04T22:34:02.409Z","avatar_url":"https://github.com/geovaneborba.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![image](https://github.com/user-attachments/assets/45dc3757-b7ea-47e2-9b65-9d7c19619b03)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Repo size\"  src=\"https://img.shields.io/github/repo-size/geovaneborba/ftr-pos-api-docs?color=4f46e5\u0026style=for-the-badge\"\u003e\n  \u003cimg alt=\"GitHub top language\"  src=\"https://img.shields.io/github/languages/top/geovaneborba/ftr-pos-api-docs?color=4f46e5\u0026style=for-the-badge\"\u003e\n  \u003cimg alt=\"GitHub language count\"  src=\"https://img.shields.io/github/languages/count/geovaneborba/ftr-pos-api-docs?color=4f46e5\u0026style=for-the-badge\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#dart-sobre\"\u003eSobre\u003c/a\u003e \u0026#xa0; | \u0026#xa0;\n  \u003ca href=\"#books-aprendizado\"\u003eAprendizado\u003c/a\u003e \u0026#xa0; | \u0026#xa0;\n  \u003ca href=\"#rocket-tecnologias\"\u003eTecnologias\u003c/a\u003e \u0026#xa0; | \u0026#xa0;\n  \u003ca href=\"#warning-pré-requisitos\"\u003e Pré requisitos\u003c/a\u003e \u0026#xa0; | \u0026#xa0;\n  \u003ca href=\"#checkered_flag-começando\"\u003eComeçando\u003c/a\u003e \u0026#xa0;\n\u003c/p\u003e\n\n\u003cbr\u003e\n\n## :dart: Sobre\n\nEste projeto tem como objetivo principal a documentação de APIs seguindo as especificações da OpenAPI. Embora utilize ferramentas como Fastify e Node.js, o foco está na implementação da documentação em si, explorando conceitos do Swagger e Scalar para criar uma interface mais amigável e intuitiva para desenvolvedores. Além disso, foram implementadas ferramentas para facilitar a escrita da documentação, como o uso do Zod para serialização e validação de dados.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eVoltar para o topo\u003c/a\u003e)\u003c/p\u003e\n\n## :books: Aprendizado\n\n- Documentação de APIs seguindo as especificações da OpenAPI\n- Swagger e Scalar para criar uma interface mais amigável e intuitiva para desenvolvedores\n- Ferramentas para facilitar a escrita da documentação, como o uso do Zod para serialização e validação de dados\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eVoltar para o topo\u003c/a\u003e)\u003c/p\u003e\n\n## :rocket: Tecnologias\n\nAs seguintes tecnologias foram usadas na construção do projeto:\n\n- [Node.js](https://nodejs.org/en/)\n- [Fastify](https://fastify.dev/)\n- [Zod](https://zod.dev/)\n- [Swagger](https://swagger.io/)\n- [Scalar](https://scalar.com/)\n- [TypeScript](https://www.typescriptlang.org/)\n\nOutras dependências e ferramentas utilizadas podem ser encontradas no arquivo [package.json](./package.json)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eVoltar para o topo\u003c/a\u003e)\u003c/p\u003e\n\n## :warning: Pré-requisitos\n\nAntes de começar, você precisa ter as seguintes ferramentas instaladas em sua máquina:\n\n- [Git](https://git-scm.com)\n- [Node.js](https://nodejs.org/en/)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eVoltar para o topo\u003c/a\u003e)\u003c/p\u003e\n\n## :checkered_flag: Começando\n\n```bash\n# Clone o repositórios abaixo\n$ git clone https://github.com/geovaneborba/ftr-pos-api-docs.git\n\n# Entre na pasta e instale as dependências\n$ cd ftr-pos-api-docs \u0026\u0026 npm i\n\n# Inicie o projeto\n$ npm run dev\n\n# A documentação estará disponível em:\n$ http://localhost:3000/docs\n```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eVoltar para o topo\u003c/a\u003e)\u003c/p\u003e\n\u003cp align=\"center\"\u003eFeito com ❤️ por \u003ca href=\"https://github.com/geovaneborba\" target=\"_blank\"\u003eGeovane Borba\u003c/a\u003e\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeovaneborba%2Fftr-pos-api-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgeovaneborba%2Fftr-pos-api-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeovaneborba%2Fftr-pos-api-docs/lists"}