In simple English
This tool turns your API specification file into a clean documentation website. You paste a single HTML tag onto your page, point it at your data file, and visitors can read your endpoints and test them live. It works inside plain HTML, React, Vue, or any other framework. It costs nothing to use, and runs entirely in your user's browser without needing a special server backend.
What it is
A customizable web component built with Lit (a small library for creating fast web components) that reads OpenAPI and Swagger specification files. It renders your endpoints, models, and authentication options into a responsive interface with built-in testing capabilities.
What it is good for
Solo builders who need to publish API documentation for their backend service without setting up heavy documentation generators or external portal subscriptions.
- Works with any frontend framework or plain HTML using a single tag.
- Includes an interactive API console so users can test requests directly in the browser.
- Comes with dark and light themes out of the box with brand color customization.
- Requires an existing OpenAPI or Swagger specification file to display anything.
- Building the source repository requires Node.js version 22 or newer.
- Limited to static HTML rendering, so complex custom backend logic requires an external setup.
Swagger UI
OpenAPI
- swagger-api/swagger-ui29k stars
The official and widely used interface for rendering Swagger and OpenAPI documentation.
- scalar/scalar16k stars
A modern, highly customizable alternative for rendering OpenAPI specifications.
- facebook/docusaurus67k stars
A static site generator from Meta that turns Markdown files into a documentation website.
- mkdocs/mkdocs23k stars
Turns a folder of Markdown files into a documentation website, controlled by one settings file.
- squidfunk/mkdocs-material28k stars
Turns a folder of Markdown files into a searchable documentation website, with every formerly sponsor-only feature now included.
git clone https://github.com/rapi-doc/RapiDoc.git cd RapiDoc npm install npm run dev