How To Use

Petstore Basic Petstore Extended Petstore
Render Style
View
Read
Focused
Dark Theme
Dark View
Dark Read
Font Styles
Font Type Font Size
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
Use API Paths in Navigation
You can override to display API Paths in Navigation Bar instead of summary
Change Header Color
Slots - HTML Injection
Inject custom HTML content at various location of your document.
Markdown
Supports markdown (headings, table, list, code etc)
Links
Provide External and Internal links to varius section of document
Markdown headings in Navigation
Optionally include markdown headings to navigation bar
Tags in focused mode
Tag clicking on navigation bar
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
Binary Response
Download or view binary response
Multipart Formdata
Submit mixed content sucha as file(binary) and plain-text using multipart-formdata
Multiple Request Body
Arranging Tags
Dynamic Parameters
Query Parameters - Dynamic Form Parameters - Dynamic
Advanced Search
Enable/Disable Advanced search

OAuth Setup

OAUTH
OAuth Demo
OAuth Extensions
pre fill client-id and client-secret with vendor extension 'x-client-id' and 'x-client-secret'
API Key in RapiDoc Element
Declaratively provide your own API Key by using, and can programatically alter it using JS
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
WebHooks
OpenAPI 3.1.0 Spec with WebHooks
Multiple DataTypes
OpenAPI 3.1.0 allows each field to have multiple data-types in accordance to JSON schema standard
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
In view & focused mode Tags can be expanded and collapsed. You may also set each tags initial state
View Mode    |    Focused Mode
Mock API
Using a Mocking API service performing realtime request and response
Play Ground
Shows various things that can be controlled using script
List of Test cases
Request Parameters
Data types
Provide Examples with nested refs
Array and Object nesting
Circular references
Read Mode without a Navigation Bar
ONE-OF combinations
Nested all-of & one-of
Nested one-of along with schema expand level restriction
Long paths
Long descriptions
Large models
Too many example generation Multiple combination of any-of and one-of can generate many examples and lead to browser-crash, this test case ensures that max 10 examples are generated
Multiple DataTypes per field Open API 3.1 allows schema field type to contain multiple type, This test case takes care of various cmbinations and nesting of per field multiple data types
Webhook Spec containing WebHooks
Various cases Spec containing one-of, all-of with primitive types, recursive models and readonly-attributes