{"id":27069396,"url":"https://github.com/alessandro1918/swagger-api","last_synced_at":"2026-04-30T10:05:47.941Z","repository":{"id":166948316,"uuid":"589736105","full_name":"Alessandro1918/swagger-api","owner":"Alessandro1918","description":"Um exemplo de documentação de rotas de API com Swagger. Especificação de endpoints, parâmetros, retorno, tudo facilmente documentável e consultável em uma página web disponível em uma rota da própria API.","archived":false,"fork":false,"pushed_at":"2024-10-07T20:53:21.000Z","size":1277,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-05T21:34:45.907Z","etag":null,"topics":["openapi","swagger"],"latest_commit_sha":null,"homepage":"https://swagger-api-kappa.vercel.app","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/Alessandro1918.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":"2023-01-16T20:17:01.000Z","updated_at":"2024-10-07T20:53:21.000Z","dependencies_parsed_at":null,"dependency_job_id":"f7830eb2-5f04-4311-bb44-1ae095fdc1c9","html_url":"https://github.com/Alessandro1918/swagger-api","commit_stats":null,"previous_names":["alessandro1918/swagger-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Alessandro1918/swagger-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alessandro1918%2Fswagger-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alessandro1918%2Fswagger-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alessandro1918%2Fswagger-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alessandro1918%2Fswagger-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Alessandro1918","download_url":"https://codeload.github.com/Alessandro1918/swagger-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alessandro1918%2Fswagger-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32460818,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-29T22:27:22.272Z","status":"online","status_checked_at":"2026-04-30T02:00:05.929Z","response_time":57,"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":["openapi","swagger"],"created_at":"2025-04-05T21:32:13.917Z","updated_at":"2026-04-30T10:05:47.926Z","avatar_url":"https://github.com/Alessandro1918.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# swagger-api\n\u003c!--\n\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"https://miro.medium.com/v2/resize:fit:200/format:webp/0*otsfLuH8efGUeedm.png\"/\u003e\n\u003c/div\u003e\n--\u003e\n![](https://sloc.xyz/github/Alessandro1918/swagger-api/)\n![](https://sloc.xyz/github/Alessandro1918/swagger-api?category=code)\n![](https://sloc.xyz/github/Alessandro1918/swagger-api?category=comments)\n\n## 🚀 Projeto\nUm exemplo de documentação de rotas de API com Swagger. Especificação de endpoints, parâmetros, retorno, tudo facilmente documentável e consultável em uma página web disponível em uma rota da própria API.\u003c/br\u003e\n\u003c/br\u003e\nConfira online! [https://swagger-api-kappa.vercel.app/api-docs/](https://swagger-api-kappa.vercel.app/api-docs/)\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://swagger-api-kappa.vercel.app/api-docs/\"\u003e\n    \u003cimg src=\"github_assets/routes.png\" alt=\"routes\" title=\"routes\" width=\"75%\"/\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://swagger-api-kappa.vercel.app/api-docs/\"\u003e\n    \u003cimg src=\"github_assets/api-auth.png\" alt=\"api-auth\" title=\"api-auth\" width=\"30%\"/\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://swagger-api-kappa.vercel.app/api-docs/\"\u003e\n    \u003cimg src=\"github_assets/api-put.png\" alt=\"api-put\" title=\"api-put\" width=\"30%\"/\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://swagger-api-kappa.vercel.app/api-docs/\"\u003e\n    \u003cimg src=\"github_assets/api-delete.png\" alt=\"api-delete\" title=\"api-delete\" width=\"30%\"/\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n## 🛠️ Tecnologias\n- [Swagger](https://swagger.io)\n- [swagger-jsdoc](https://www.npmjs.com/package/swagger-jsdoc)\n- [swagger-ui-express](https://www.npmjs.com/package/swagger-ui-express)\n\n## 🧊 Cool features\n- Autenticação de usuários (login) com [JWT](https://jwt.io) para uso das rotas autenticadas.\n- Controle de sessão de usuário com \u003ccode\u003eaccessToken\u003c/code\u003e(validade curta (ex.: 5 min)) e \u003ccode\u003erefreshToken\u003c/code\u003e(revalida sessão automaticamente sem precisar repetir login).\n- Limite de acessos por período (Ex.: 60 requests por minuto).\n- Requisições de envio de dados (JSON) e arquivos (Multipart form).\n\n## 🗂️ Utilização\n\n### 🐑🐑 Clonando o repositório:\n\n```bash\n  $ git clone url-do-projeto.git\n```\n\n### ▶️ Rodando o App:\n\n```bash\n  $ cd swagger-api        #change to that directory\n  $ cp .env.example .env  #create the \".env\" file like the \".env.example\" file\n  $ npm install           #download dependencies to node_modules\n  $ npm run dev           #start the project\n```\n\nConsultar a documentação em: [localhost:4000/api-docs](http://localhost:4000/api-docs)\n\n## ⭐ Like, Subscribe, Follow!\nCurtiu o projeto? Marque esse repositório com uma Estrela ⭐!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falessandro1918%2Fswagger-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falessandro1918%2Fswagger-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falessandro1918%2Fswagger-api/lists"}