Examples Gallery
Browse interactive examples, theming recipes, layout styles, and OpenAPI 3.1 features. Click any card to launch the live demo or guide.
Open API Example
Interactive showcase demonstrating how RapiDoc renders a OpenAPI 3.1 and 3.2 specifications.
Themes and Colors
Match your corporate brand by customizing primary accents, headers, backgrounds, and text colors.
CSS Styling
Customize using CSS variables and CSS Shadow Parts for deep layout and style control.
Rendering Modes
Choose between 3 distinct presentation styles to best fit your audience.
Built In Console
Call and test live API endpoints directly within the documentation, with support for negative and edge-case testing.
Schema Styles
Inspect data models using Tree or Tabular representations, and toggle between Schema and Example views.
Show Components
Expose and browse standalone schema definitions, request bodies, and security components in focused mode.
Navigation Styles
Customize navigation sidebar styles, item spacing, active indicators, and endpoint grouping.
Slots - HTML Injection
Inject custom HTML content, warning banners, company logos, and navigation links into Shadow DOM slots.
Markdown
Rich Markdown rendering inside API descriptions, including tables, formatted lists, and callout blocks.
Markdown Headings in Navigation
Automatically convert Markdown headers inside descriptions into interactive navigation links.
Tags with Focused mode
Organize and collapse endpoint operations into expandable tag categories within focused mode.
Links
Create deep cross-references and external links between operations, schemas, and external documentation.
Syntax Highlighting
Built-in syntax highlighting for cURL, JavaScript, Python, Go, and 20+ programming languages.
Code Samples
Display multi-language code snippets on operations using the OpenAPI x-code-samples vendor extension.
Endpoint Badges
Annotate operations with custom color-coded status badges (Beta, Deprecated, Internal) using x-badges.
Add Your Examples
Provide multiple request and response payload examples to illustrate edge cases and error scenarios.
File Upload
Interactive testing for endpoints accepting binary files, document uploads, and streaming data.
Binary Response
Handle and download binary responses such as PDF documents, image assets, and archive files.
Multipart Formdata
Submit mixed content combining binary files with structured JSON fields using multipart/form-data.
Multiple Request Body
Document endpoints supporting alternate payload formats such as JSON, XML, or plain text.
Arrange Endpoints Using Tags
Structure and order operations by logical tags to create clean, intuitive navigation groups.
Dynamic Parameters
Inject dynamic query, path, and header parameters at runtime without pre-specifying them in the schema.
Advanced Search
Enhance search capability to filter operations by parameter names, descriptions, and HTTP verbs.
OAuth
Interactive OAuth 2.0 demonstration covering implicit flow, authorization code, and token refresh.
OAuth Extensions
Pre-populate client IDs, client secrets, and default scopes using x-client-id and x-default-scopes vendor extensions.
Authentication (Multiple)
Configure complex multi-layered security schemes including API Keys, Bearer JWT, and Basic Auth.
API Key as RapiDoc Attribute
Declaratively set and programmatically update API keys via DOM attributes or JavaScript properties.
Additional Properties
Define and validate open dictionary schemas with dynamic keys using OpenAPI additionalProperties.
Embed RapiDoc In HTML
Seamlessly co-exist with existing HTML pages, headers, footers, and enterprise design systems.
JSON Object as OpenAPI Spec
Pass in-memory JavaScript objects directly to RapiDoc without needing an external URL or file fetch.
Define API Server Using Template
Support dynamic multi-environment server URLs using variable substitution and template parameters.
Callback
Document asynchronous webhooks and subscription callbacks triggered by client requests.
Webhook
OpenAPI 3.1 top-level webhook definitions for server-initiated asynchronous events.
Multiple DataTypes
Utilize OpenAPI 3.1 multi-type declarations conforming to the latest JSON Schema specifications.
Spec Split into Multiple Files
Modularize enterprise API catalogs by splitting schemas and operations across multiple linked JSON/YAML files.
No matching examples found
Try searching for a different keyword or reset the category filters.