Common Tasks
Each task links to the page that covers it, so there is one place to read and one place to keep up to date.
Put the reference on a site
Section titled “Put the reference on a site”| To | Read |
|---|---|
| Show a spec on a page, in one HTML file | Quickstart |
| Use it in React, Next.js, Vue, Nuxt, Angular or Svelte | Front-End Frameworks |
| Serve it from your Hono, Express, Fastify, FastAPI, ASP.NET Core or Go API | Integrations |
| Add it to a Starlight, VitePress or Docusaurus site | Documentation Sites |
| Load a spec from a URL, a file, a string or several files | Loading Your Spec |
| Build a portal with guides, search and sign-in | RapiDoc Portal |
Make it look like your site
Section titled “Make it look like your site”| To | Read |
|---|---|
| Use your brand color, light or dark | Theming Overview |
| Pick a built-in theme | Built-in Themes |
| Restyle one part, or the headings | CSS Parts & Variables |
| Add a logo, a header, a footer or notes under an operation | HTML Slots |
| Show Markdown headings in the sidebar | Markdown Headings in the Sidebar |
| Link to an operation from elsewhere | Links & Navigation |
Let readers try the API
Section titled “Let readers try the API”| To | Read |
|---|---|
| Sign in with OAuth 2.0 or OpenID Connect | OAuth 2.0 |
| Answer Try requests without a backend | In-Browser Mock (live example) |
| Run a mock API that any client can call | Mock Server |
| Change requests and responses from JavaScript | Events |
Go beyond the reference
Section titled “Go beyond the reference”| To | Read |
|---|---|
| Embed one endpoint in a blog post or tutorial | RapiDoc Mini |
| Show and run a multi-step workflow | RapiFlow |
| Give AI agents tools for your API | MCP Server |
| Publish the reference as a PDF | RapiPdf |
| Check the spec in CI | rapidoc validate and rapidoc lint |
| Make the reference indexable, with no blank first paint | Pre-rendering |
| Keep a large spec fast | Large Specs |
| Upgrade from an older version | Migration Guides |