Skip to content
RapiDocv11.0
GitHub

RapiDoc Documentation

RapiDoc is an ultra-fast, zero-dependency OpenAPI documentation renderer built on native Web Components. It transforms any OpenAPI 3.x (and 2.0) specification into an interactive, beautifully styled developer portal that embeds seamlessly into any web stack.

Core Capabilities

Section titled “Core Capabilities”

Zero Dependencies

Built directly on web standards with no React, Vue, or heavy client bundle dependencies. Load it from a CDN or install via npm.

Tailored Theming

Customize colors, typography, and dark/light modes using simple HTML attributes, or gain pixel-level control with modern CSS ::part() pseudo-elements.

3 Distinct Render Modes

Choose between Read (continuous scrolling), View (collapsible categories), or Focused (lazy-loaded single endpoint view for massive specs).

Full JavaScript SDK

Control RapiDoc programmatically at runtime: intercept network requests (before-try), inject auth credentials dynamically, and control navigation via code.

30-Second Quickstart

Section titled “30-Second Quickstart”

Include the script tag, drop in the <rapi-doc> element, and you have a fully functional interactive API explorer.

<!doctype html>
<html>
  <head>
    <meta charset="utf-8" />
    <!-- Load RapiDoc Web Component -->
    <script type="module" src="https://unpkg.com/rapidoc/dist/rapidoc-min.js"></script>
  </head>
  <body>
    <rapi-doc
      spec-url="https://petstore.swagger.io/v2/swagger.json"
      theme="dark"
      render-style="read"
      show-header="false"
    ></rapi-doc>
  </body>
</html>

Documentation Roadmap

Section titled “Documentation Roadmap”

Dive deeper into RapiDoc by exploring our dedicated guides: