RapiDoc Everywhere
Add an API reference to the server that runs your API, the docs site you already have, or your app. Every integration follows one contract, so they take the same options and serve the same page.
Serve the Reference Next to Your API
These packages add the page, the bundle and the OAuth return page to your app: no HTML to write. Each serves the reference at /docs and takes any attribute of <rapi-doc> as an option.
Hono@rapidoc/hono
Middleware that serves the reference at /docs; on Cloudflare Workers, import @rapidoc/hono/edge.
npm install @rapidoc/honoapp.use(rapidoc({ specUrl: '/openapi.json' }));Setup Express@rapidoc/express
Middleware that serves the reference at /docs, with the bundle and the OAuth return page.
npm install @rapidoc/expressapp.use(rapidoc({ specUrl: '/openapi.json' }));Setup Fastify@rapidoc/fastify
A plugin with the same options as the Express and Hono packages; honors Fastify's prefix.
npm install @rapidoc/fastifyawait fastify.register(rapidoc, { specUrl: '/openapi.json' });Setup FastAPI & Starletterapidoc (PyPI)
Reads the app's own /openapi.json. For plain Starlette, import from rapidoc.starlette.
pip install rapidocsetup_rapidoc(app, options={"render_style": "focused"})Setup ASP.NET CoreRapiDoc.AspNetCore
An endpoint for .NET 8 or later, next to MapOpenApi(), Swashbuckle or NSwag.
dotnet add package RapiDoc.AspNetCoreapp.MapRapiDoc();Setup Gorapidoc-go
A net/http handler with no dependencies, so it also mounts on chi, Gin, Echo and Fiber.
go get github.com/rapi-doc/rapidoc-gomux.Handle("/docs/", rapidoc.Handler(opts))Setup An API Reference Inside Your Docs Site
A page per API in the site's own layout, with the API's tags and operations in its sidebar.
Starlight@rapidoc/starlight
A page per API in Starlight's layout and themes, with its operations in Starlight's sidebar.
npm install @rapidoc/starlightplugins: [starlightRapidoc({ uiPath: '/api', spec: './openapi.yaml' })]Setup VitePress@rapidoc/vitepress
Wrap the config with withRapidoc, build the sidebar with rapidocSidebar, add the component to a page.
npm install @rapidoc/vitepress<RapidocReference api="pets" />Setup Docusaurus@rapidoc/docusaurus
A plugin for the specs, a React component for the page and rapidocSidebarSync for the sidebar.
npm install @rapidoc/docusaurus<RapidocReference api="pets" />Setup A Web Component Works Everywhere
<rapi-doc> is a standard custom element, so no wrapper package is needed: a line of setup at most.
React & Next.js
Import rapidoc in a client component and write the element; the package ships JSX types for its attributes.
Vue & Nuxt
Tell the Vue compiler that rapi- tags are custom elements, then import rapidoc on mount.
Angular
Add CUSTOM_ELEMENTS_SCHEMA to the component that uses the element.
Svelte, Astro & bundlers
No configuration: import rapidoc in a client-side script and write the element.