How To Use

Petstore Basic Petstore Extended Petstore
Render Style
View
Read
Focused
Dark Theme
Dark View
Dark Read
Change Font
Change Logo
Theme
Play with various color schemes

Branding Ideas

Schema Style
Tree / Table
Schema Expand Level
Built in API console
Default Schema View
Set the default tab in Schema to EXAMPLE instead on MODEL
Navigation Item Spacing
Compact / Default / Relaxed
Markdown headings in Navigation
Optionally include markdown headings to navigation bar
Change Header Color
Markdown
Supports markdown (headings, table, list, code etc)
Syntax Highlighting
supports syntax highlighting in markdown for common languages
Code Samples
Support for x-code-samples (vendor extension) in endpoint definition
Examples
Provide multiple request and response examples for your APIs
File Upload
Multiple Request Body
Arranging Tags
Dynamic Parameters
Query Parameters - Dynamic Form Parameters - Dynamic

OAuth Setup

OAUTH
OAuth Demo
Additional Properties
Apart from fixed predefined properties, schema can contain additional properties
Embed RapiDoc In HTML
rapi-doc element can exist with other html content
Embed HTML In RapiDoc
Custom HTML content can be inserted in various sections of RapiDoc

Performance Tips

JSON Object as OpenAPI Spec
programmatically load a JSON object (should not contain external JSON refs)
API Server using variables
Define API server using variables, to dynamically connect to different servers

Mix HTML content

Callbacks
Specs with Callback (webhooks) Info
Spec split into multiple files
Large Specs split into multiple files referring each other with JSON refs
Schema Composition
ONE OF ANY OF ALL OF
Collapsable tags
Collapsable tags with possibility to change load state (open/closed)
Play Ground
Shows various things that can be controlled using script
List of Test cases
Data types
Circular references
Nested all-of & one-of
Long paths
Long descriptions
Large models
Various cases Spec containing one-of, all-of with primitive types, recursive models and readonly-attributes
Large Swagger 2.0 Spec Performance (Bad - browser may become unresponsive ) Most of the time is taken by swagger 2 to OpenAPI conversion
Large OpenAPI 3.0 Spec Performance - Read Mode (Okay - browser wont hang) The above spec pre-converted to OpenAPI 3 - (read-mode renders everything in one large page, resulting into very large DOM, the user interactions like expand collapse are not much snappier)
Large OpenAPI 3.0 Spec Performance - View Mode (Fast) view mode - Fast (initial load is quick and user interaction is snappy, DOM is a bit larger than focused mode but very small compared to read mode)
Large OpenAPI 3.0 Spec Performance - Focused Mode (Fastest) focused mode - Fastest (focused mode loads only the section that user is viewing, resulting into a small DOM footprint and snappier interactions)