{"id":14986551,"url":"https://github.com/rapi-doc/rapidoc","last_synced_at":"2025-05-13T00:09:59.127Z","repository":{"id":37853759,"uuid":"165951750","full_name":"rapi-doc/RapiDoc","owner":"rapi-doc","description":"RapiDoc -WebComponent for OpenAPI Spec","archived":false,"fork":false,"pushed_at":"2025-04-16T15:31:03.000Z","size":96302,"stargazers_count":1798,"open_issues_count":100,"forks_count":303,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-05-13T00:09:37.932Z","etag":null,"topics":["api","custom-element","documentation","open-api","openapi3","rapidoc","rest","swagger","swagger-ui"],"latest_commit_sha":null,"homepage":"https://rapidocweb.com","language":"JavaScript","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/rapi-doc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.txt","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},"funding":{"github":null,"patreon":null,"open_collective":"rapidoc","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":["paypal.me/mrin"]}},"created_at":"2019-01-16T01:29:58.000Z","updated_at":"2025-05-12T09:31:56.000Z","dependencies_parsed_at":"2023-12-26T08:46:22.338Z","dependency_job_id":"bf0c9ec8-e3c7-4ab8-8702-5ddbbd3408d5","html_url":"https://github.com/rapi-doc/RapiDoc","commit_stats":{"total_commits":1457,"total_committers":116,"mean_commits":"12.560344827586206","dds":"0.16884008236101578","last_synced_commit":"7f53d25959e5a4e1beb4b610aaef445b896838f2"},"previous_names":["mrin9/rapidoc"],"tags_count":84,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rapi-doc%2FRapiDoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rapi-doc%2FRapiDoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rapi-doc%2FRapiDoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rapi-doc%2FRapiDoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rapi-doc","download_url":"https://codeload.github.com/rapi-doc/RapiDoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253843215,"owners_count":21972873,"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","custom-element","documentation","open-api","openapi3","rapidoc","rest","swagger","swagger-ui"],"created_at":"2024-09-24T14:13:07.577Z","updated_at":"2025-05-13T00:09:59.100Z","avatar_url":"https://github.com/rapi-doc.png","language":"JavaScript","readme":"\u003cimg alt=\"MrinDoc logo\" src=\"https://github.com/rapi-doc/RapiDoc/blob/master/logo.png\" width=\"60px\" /\u003e\n\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square\"/\u003e\n    \u003cimg src=\"https://img.shields.io/github/size/rapi-doc/rapidoc/dist/rapidoc-min.js.svg?colorB=blue\u0026label=minified\u0026style=flat-square\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/size/rapi-doc/rapidoc/dist/rapidoc-min.js.gz.svg?colorB=blue\u0026label=zip\u0026style=flat-square\"\u003e\n    \u003ca href=\"https://www.webcomponents.org/element/rapidoc\" alt=\"published on webcomponents.org\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/webcomponents.org-rapidoc-blue.svg?style=social\"/\u003e\n    \u003c/a\u003e\n\u003c/p\u003e        \n\n# RapiDoc\nCustom Element for Open-API spec viewing\n\n\u003e Sponsored by [Zuplo](https://zuplo.link/rapidoc-2) - Get a Stripe-like API experience for your customers in minutes - documentation, rate-limiting and API-key auth in minutes. \n\n## Features\n- Supports Swagger 2.0, OpenAPI 3.x.x \n- Works with any framework or with no framework\n- Allows making API calls\n- Better Usability, \n  - all Models and Examples are expanded by default, eliminates the need to click and reveal.\n  - Request fields are pre-populated with sample data\n  - Takes only one click to make an API call\n  - Request and response can be placed side-by-side for easy comparison\n- Branding and Personalization features makes it easy to follow any style guide\n  - Comes with 2 Themes (Dark and Light)\n  - Replace default logo with yours\n  - Typography, allows changing fonts\n  - Allows changing text-color, button-color, header-color and color of other UI elements\n- Plenty of customization options \n  - Add external contents at the top and bottom of the document,  you may add images, link, text, forms etc\n  - Allows disabling API calling feature\n  - Hide the header, so the user can't load any other OpenAPI Spec\n  - Hide Authentication and provide your own pre-generated api-key \n  - Embed it inside another HTML document\n  - Use it inside another framework (react, vue, angular, lit-element)\n  - Use JavaScript to change its attributes, and it will react to those changes\n  - Style the element with standard css (change padding, position, border, margin )\n- Lightweight and fast\n- Load local json spec from the disk\n- Supported on Chrome, FireFox and Safari. (Not yet tested on Edge)\n\n\n## Documentation\n[Check out the usage and demos](https://rapi-doc.github.io/RapiDoc/)\n\n## Examples\n[Examples and Test cases](https://rapi-doc.github.io/RapiDoc/list.html)\n\n\n## Build Process\n```bash\n# Clone / Download the project then\nnpm install\n\n# build will generate rapidoc-min.js, this is the only file you will need.\n# use it in the script tag of your html \u003cscript type=\"text/javascript\" src=\"rapidoc-min.js\"\u003e\u003c/script\u003e\u003c/body\u003e\nnpm run build \n\n# for development use yarn serve (this will start an webserver at port 8080, then navigate to localhost:8080) \nnpm run serve\n```\n\n## Roadmap\n- ✅ Upgrade to use `lit 2`\n- Pre Rendering / Server Side Rendering (SSR) of RapiDoc\n- Improve PDF generation of OpenAPI spec Using RapiPDF\n- Create a Command Line interface (CLI) to make it automation friendly\n- Add localization support\n- Follow Web Content Accessibility Guidelines (WCAG 2)\n- Improve Homepage, Documentation and Examples\n- Create groundwork for automated testing\n- Create a live playground (Something like swagger editor)\n- Create a short animation/video to show how RapiDoc/RapiPDF works\n\n","funding_links":["https://opencollective.com/rapidoc","paypal.me/mrin"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frapi-doc%2Frapidoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frapi-doc%2Frapidoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frapi-doc%2Frapidoc/lists"}