Integrations
<rapi-doc> is a standard custom element, so a page in any framework can use it with a line of setup. The integrations go further: they serve the reference from the app that serves your API, or add reference pages to your documentation site, so there is no HTML to write.
| You have | Use | Page |
|---|---|---|
| A React, Next.js, Vue, Nuxt, Angular, Svelte or Astro app | rapidoc, the element itself |
Front-End Frameworks |
| A Hono, Express or Fastify API | @rapidoc/hono, @rapidoc/express, @rapidoc/fastify |
Hono, Express & Fastify |
| A FastAPI or Starlette API | rapidoc on PyPI |
FastAPI & Starlette |
| An ASP.NET Core API | RapiDoc.AspNetCore on NuGet |
ASP.NET Core |
A Go API (net/http, chi, Gin, Echo, Fiber) |
github.com/rapi-doc/rapidoc-go |
Go |
| A Starlight, VitePress or Docusaurus site | @rapidoc/starlight, @rapidoc/vitepress, @rapidoc/docusaurus |
Documentation Sites |
| A full developer portal, with guides, search and sign-in | @rapidoc/cli and @rapidoc/portal |
RapiDoc Portal |
One contract
Section titled “One contract”The server-framework packages all follow one contract, defined in @rapidoc/embed: they take the same options (any attribute of <rapi-doc>), serve the same routes (the page at /docs, the bundle, the OAuth return page) and send the same HTML. The Python, .NET and Go packages are ports of it that pass the same fixtures. So moving an API from one framework to another keeps its reference the same.
Build an IntegrationWrite one for another framework, site generator or tool, in any language.
All integrations at a glanceThe overview page, with the install line of each.