Interactive OpenAPI Spec Sandbox & Live Editor | RapiDoc

Upload

RapiDoc Tuner

RapiDoc properties

Display & Layout

Render Style

Display mode: Read for docs, View with tabs, Focused for single endpoint

ReadViewFocused

Schema Style

Display schemas as visual table or tree hierarchy

TableTree

Req/Res Layout

Request and response layout: row (side-by-side) or column (stacked)

RowColumn

Heading Text

Top header title text

DefaultAPI Explorer

Colors & Fonts

UI Scale

Global scale for typography and spacing

CompactDefaultLarge

Theme

Color palette preset

Color Scheme

Light or dark luminance scheme

DarkLightSystem

Radius

Border radius for cards, inputs, and buttons

NoneSmallMediumLargeFull

Regular Font

Main document body and heading font family

DefaultNunitoRoboto Mono

Mono Font

Monospace font family for code blocks and schema types

DefaultCourier

Sidebar & Navigation

Nav Text

Display endpoint URL path or summary in sidebar

PathSummary

Method Display

Sidebar HTTP method badge presentation style

NonePlainColoredBlock

Nav Marker

Visual marker indicating active endpoint in sidebar

Left BarBlock

Nav Spacing

Vertical spacing between sidebar navigation items

CompactDefaultRelaxed

Sort Tags

Alphabetically sort tag sections in sidebar

FalseTrue

Nav Headings

Extract H1 and H2 markdown headings into sidebar navigation

TrueFalse

Update Route

Update browser URL hash when navigating endpoints

TrueFalse

Route Prefix

URL hash prefix for endpoint routing

##/#!

Tag Click

Works only when render-style = focused

Behavior when clicking a tag header in the sidebar

ExpandDescription

Schema

Schema Tab

Default active tab in request and response bodies

SchemaExample

Expand Level

Initial expansion depth for nested schemas (max 999)

1239

Hide Read-Only

Hide read-only fields from request body schemas

DefaultNever

Hide Write-Only

Hide write-only fields from response body schemas

DefaultNever

Desc Expanded

Display full multiline schema property descriptions by default

Desc Toggle

Show toggle button for multiline schema descriptions

Fill Examples

Pre-populate "Try" console parameters with sample values

Interactive Sections

Header

Display the top navbar header

Info Section

Display OpenAPI document title and overview info

Try Console

Live interactive endpoint testing console

Show cURL

Display cURL command before invoking API

Servers

Allow switching between configured API server URLs

Auth Section

Display authentication button and credential modal

Persist Auth

Persist API keys and tokens in browser localStorage

Search

Enable quick endpoint search bar

Adv Search

Enable advanced full-text schema and parameter search

Components

Display Schemas and Models in navigation

Spec URL Load

Allow loading arbitrary OpenAPI spec by URL

Spec File Load

Allow uploading and viewing local OpenAPI spec file

Spec Download

Show download button for the active OpenAPI spec

Mock Server

Route requests through local or hosted mock server

Methods & Actions

Load Spec

Switch the active OpenAPI specification document

Scroll To Path

Smoothly scroll to an endpoint or section ID

Slots

Nav Logo Slot

Inject custom logo & text HTML into sidebar navigation

Fixed Header Slot

Inject custom sticky announcement or banner HTML above content

Default Slot

Inject custom top-level announcement HTML into main content body

Live Spec Editor

YAML / JSON

Cmd + Enter to apply

📥

Drop OpenAPI Spec

Drop any .yaml or .json file to render immediately