Skip to content
Portal

Your APIs and guides
one developer portal

Point RapiDoc Portal at your OpenAPI files, write guides in Markdown or Markdoc, and get a fast static portal with search, an API catalog and interactive references. This site is built with it.
QuickstartSee an API reference

Everything a developer portal needs

Section titled “Everything a developer portal needs”

Interactive API reference

Every OpenAPI 3.0, 3.1 or Swagger 2.0 spec gets a reference page rendered by RapiDoc, with Try, code samples and a sidebar that stays in view.

Guides as code

Markdown, MDX and Markdoc pages in a docs/ folder. Callouts, tabs, steps, cards, and live API operations inside a guide.

One config file

rapidoc.config.yaml describes the header, tabs, sidebars, theme and footer. A strict schema names every typo.

Search built in

Full-text search across guides and API operations, indexed at build time. No search service to run.

Sign-in and access rules

Optional OpenID Connect sign-in. Decide who may read which pages, APIs and files, by group or email.

Mock server

Serve your specs with their examples, validate requests, and check real OAuth scopes, so Try works before the API does.

From zero to portal

Section titled “From zero to portal”
npm create rapidoc@latest my-portal
cd my-portal
npm run dev

The starter finds the OpenAPI files already in the folder, writes a rapidoc.config.yaml and a first guide, and opens the portal on http://localhost:4321. Read the quickstart.

A live operation, right in a guide

Section titled “A live operation, right in a guide”

Guides can embed any operation from your specs. This one comes from the example Bookstore API. Run npm run mock in this site's repository and Try answers from the mock server.

Moving from Zudoku or Redocly?

rapidoc migrate --from zudoku or --from redocly writes a rapidoc.config.yaml from your existing project. See migrating.