{"id":13504832,"url":"https://github.com/joaomede/Api-Doc","last_synced_at":"2025-03-29T22:31:13.360Z","repository":{"id":37181479,"uuid":"230288627","full_name":"joaomede/Api-Doc","owner":"joaomede","description":"A Technology for Rest API Documentation :computer: :scroll: \"Dockerized\"","archived":false,"fork":false,"pushed_at":"2023-06-22T13:03:27.000Z","size":4814,"stargazers_count":15,"open_issues_count":9,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-25T18:13:20.585Z","etag":null,"topics":["api","client-electron","docker","docker-compose","documentation","documentation-tool","express","quasar","quasar-framework","register","rest","rest-api","vuejs"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/joaomede/apidoc","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joaomede.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":["joaomede"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2019-12-26T15:45:34.000Z","updated_at":"2023-11-29T23:08:18.000Z","dependencies_parsed_at":"2024-01-17T07:08:50.727Z","dependency_job_id":"ba516c83-4251-40bf-baf9-8d5276cd16c5","html_url":"https://github.com/joaomede/Api-Doc","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joaomede%2FApi-Doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joaomede%2FApi-Doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joaomede%2FApi-Doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joaomede%2FApi-Doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joaomede","download_url":"https://codeload.github.com/joaomede/Api-Doc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246254077,"owners_count":20747946,"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","client-electron","docker","docker-compose","documentation","documentation-tool","express","quasar","quasar-framework","register","rest","rest-api","vuejs"],"created_at":"2024-08-01T00:00:52.084Z","updated_at":"2025-03-29T22:31:09.509Z","avatar_url":"https://github.com/joaomede.png","language":"Vue","funding_links":["https://github.com/sponsors/joaomede","https://www.buymeacoffee.com/iSTozIC"],"categories":["Awesome Quasar [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome)","Vue"],"sub_categories":["Tutorials"],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./view/src/statics/app-logo-512x512.png\"height=\"130\"\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"http://commitizen.github.io/cz-cli/\" alt=\"Commitizen friendly\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/commitizen-friendly-brightgreen.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://img.shields.io/github/workflow/status/joaomede/Api-Doc/main?label=Build%20API\" alt=\"Build Api\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/workflow/status/joaomede/Api-Doc/main?label=Build%20API\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://travis-ci.com/joaomede/Api-Doc\" alt=\"Build Status\"\u003e\n        \u003cimg src=\"https://travis-ci.com/joaomede/Api-Doc.svg?branch=master\" /\u003e\n    \u003c/a\u003e\n    \u003cimg alt=\"GitHub release (latest by date)\" src=\"https://img.shields.io/github/v/release/joaomede/Api-Doc\"\u003e    \u003ca href=\"https://img.shields.io/github/license/joaomede/api-doc\" alt=\"GitHub repo size\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/repo-size/joaomede/api-doc\" /\u003e\n    \u003c/a\u003e\n    \u003cimg alt=\"GitHub\" src=\"https://img.shields.io/github/license/joaomede/Api-Doc\"\u003e\n    \u003ca href=\"https://www.codacy.com/manual/joaomede/Api-Doc?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=joaomede/Api-Doc\u0026amp;utm_campaign=Badge_Grade\" alt=\"Codacy Badge\"\u003e\n        \u003cimg src=\"https://api.codacy.com/project/badge/Grade/cb8e4c89586a43809c7a817a07f56309\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://sourceforge.net/projects/api-doc/files/Api%20Doc-2.1.6.AppImage/download\" alt=\"Linux Client\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/Linux_Client:_AppImage-v2.1.5-blue.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://sourceforge.net/projects/api-doc/files/Api%20Doc%202.1.5.exe/download\" alt=\"Windows Client\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/Windows_Client:_Setup_EXE-v2.1.5-blue.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://sourceforge.net/projects/api-doc/files/ApiDoc-2.1.6.apk/download\" alt=\"Android Cordova\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/Android_Cordova:_APK-v2.1.6-blue.svg\" /\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\nAPI Doc is an API Rest test technology, it works as a CRUD, where you can access the documentation from anywhere, I was inspired by applications like Swagger, Postman and Insonmia to create it.\n\n### Mobile - (Cordova or PWA)\n\n|              Main Menu              |              List Api               |                Paths                |\n| :---------------------------------: | :---------------------------------: | :---------------------------------: |\n| ![](documentation/docs/image/1.png) | ![](documentation/docs/image/2.png) | ![](documentation/docs/image/3.png) |\n\n\n\u003ca href=\"https://www.buymeacoffee.com/iSTozIC\" target=\"_blank\"\u003e\u003cimg src=\"https://cdn.buymeacoffee.com/buttons/lato-blue.png\" alt=\"Buy Me A Coffee\" style=\"height: 35px !important;width: 150px !important;\" \u003e\u003c/a\u003e\n\n### Client Electron for Desktop\n\n![Destkop Electron](documentation/docs/image/electronDesktop.png)\n\n\u003e Attention: Cordova and Electron Builds ask for the address of a Remote API, they work only as customers, while the PWA version does not make this requirement, as it runs in the same container as the API - for more, see in docs [\"Cordova And Electron Docs\"](https://joaomede.github.io/Api-Doc/pages/CordovaAndElectron.html)\n\n## Get Started\n\n### See Full [Documentation](https://joaomede.github.io/Api-Doc)\n\n### Need to get started fast? go docker [Docker Compose Settings](https://joaomede.github.io/Api-Doc/pages/Docker.html)\n\n[![dockeri.co](https://dockeri.co/image/joaomede/apidoc)](https://hub.docker.com/r/joaomede/apidoc)\n\n### Features\n\n- [x] Dockerized? Yes!\n- [x] Login and Register, Change Password\n- [x] Team System\n- [x] Api Documentation \"private and public\"\n- [x] Client Electron for Windows, Mac And Linux Dist\n- [x] PWA/SPA Works\n- [ ] SSR Builder\n- [x] Cordova Android\n- [ ] Cordova iOS\n- [x] Test Request\n- [x] Register Responses and Codes Definitions\n- [x] Methods Accept: Post, Get, Delete, Put\n- [x] Accept: Headers, Params Path and Body\n- [x] Accept: Query Params\n- [ ] Accept: DataForm, in Dev\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoaomede%2FApi-Doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoaomede%2FApi-Doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoaomede%2FApi-Doc/lists"}