RapiDoc

RapiDoc Configuration API

RapiDoc web component configuration attributes for general settings, colors and fonts, navigation bar, layout, sections, schema, and API server options.

GitHub OpenAPI

Operations 3

GET /api.html Get RapiDoc API Reference #
GET /examples.html Get RapiDoc Examples and Demos #
GET /quickstart.html Get RapiDoc Quick Start Guide #

Documentation

📖
Documentation
https://rapidocweb.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/rapidoc/refs/heads/main/openapi/rapidoc-configuration-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/rapidoc/refs/heads/main/json-schema/rapidoc-configuration.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/rapidoc/refs/heads/main/json-schema/rapidoc-slots.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/rapidoc/refs/heads/main/json-schema/rapidoc-events.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/rapidoc/refs/heads/main/json-structure/rapidoc-configuration-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/rapidoc/refs/heads/main/json-structure/rapidoc-events-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/rapidoc/refs/heads/main/json-structure/rapidoc-slots-structure.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/rapidoc/refs/heads/main/json-ld/rapidoc-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/rapidoc/refs/heads/main/examples/rapidoc-basic-embed-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/rapidoc/refs/heads/main/examples/rapidoc-branded-embed-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/rapidoc/refs/heads/main/examples/rapidoc-javascript-api-example.json
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/rapidoc/refs/heads/main/rules/rapidoc-rules.yml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/rapidoc/refs/heads/main/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/rapidoc-configuration-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

rapidoc-configuration-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: RapiDoc Configuration API
  description: RapiDoc is a fast, embeddable web component that renders OpenAPI (Swagger) 2.0/3.x specifications as interactive API documentation. This OpenAPI specification represents the conceptual API surface of the RapiDoc web component, including its configuration attributes, methods, events, and slots. RapiDoc is a client-side web component and does not expose a traditional REST API. It is configured via HTML attributes and JavaScript methods on the <rapi-doc> custom element.
  version: 9.3.4
  contact:
    name: RapiDoc
    url: https://rapidocweb.com/
  license:
    name: MIT
    url: https://github.com/rapi-doc/RapiDoc/blob/master/LICENSE
servers:
- url: https://rapidocweb.com
  description: RapiDoc Documentation Site
tags:
- name: Configuration
  description: RapiDoc web component configuration attributes for general settings, colors and fonts, navigation bar, layout, sections, schema, and API server options.
paths:
  /api.html:
    get:
      operationId: getApiReference
      summary: Get RapiDoc API Reference
      description: Returns the RapiDoc API reference page documenting all available attributes, methods, events, and slots for the rapi-doc web component.
      tags:
      - Configuration
      responses:
        '200':
          description: Successful response returning the API reference page.
          content:
            text/html:
              schema:
                type: string
  /examples.html:
    get:
      operationId: getExamples
      summary: Get RapiDoc Examples and Demos
      description: Returns the RapiDoc examples and demo page showcasing various configurations and use cases.
      tags:
      - Configuration
      responses:
        '200':
          description: Successful response returning the examples page.
          content:
            text/html:
              schema:
                type: string
  /quickstart.html:
    get:
      operationId: getQuickStart
      summary: Get RapiDoc Quick Start Guide
      description: Returns the RapiDoc quick start guide with instructions for integrating the web component.
      tags:
      - Configuration
      responses:
        '200':
          description: Successful response returning the quick start page.
          content:
            text/html:
              schema:
                type: string
externalDocs:
  description: RapiDoc API Reference
  url: https://rapidocweb.com/api.html