https://github.com/rapi-doc/RapiDoc

RapiDoc -WebComponent for OpenAPI Spec
https://github.com/rapi-doc/RapiDoc

api custom-element documentation open-api openapi3 rapidoc rest swagger swagger-ui

Last synced: 21 days ago
JSON representation

RapiDoc -WebComponent for OpenAPI Spec

• Host: GitHub
• URL: https://github.com/rapi-doc/RapiDoc
• Owner: rapi-doc
• License: mit
• Created: 2019-01-16T01:29:58.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2025-03-11T02:27:47.000Z (about 1 month ago)
• Last Synced: 2025-03-22T07:34:24.044Z (23 days ago)
• Topics: api, custom-element, documentation, open-api, openapi3, rapidoc, rest, swagger, swagger-ui
• Language: JavaScript
• Homepage: https://rapidocweb.com
• Size: 91.6 MB
• Stars: 1,773
• Watchers: 14
• Forks: 299
• Open Issues: 87
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome - rapi-doc/RapiDoc - RapiDoc -WebComponent for OpenAPI Spec (JavaScript)
• awesome-documentation - RapiDoc - WebComponent Custom Element for OpenAPI Spec viewing. (Documentation Types / API Documentation)
• awesome-integration - RapiDoc (⭐1.7k) - Produces highly customizable, interactive API documentation with responsive design and rich configuration options. (Projects / API Documentation)
• jimsghstars - rapi-doc/RapiDoc - RapiDoc -WebComponent for OpenAPI Spec (JavaScript)

README

        




    

    

    

    

        

    

        


# RapiDoc

Custom Element for Open-API spec viewing

> Sponsored by [Zuplo](https://zuplo.link/rapidoc-2) - Get a Stripe-like API experience for your customers in minutes - documentation, rate-limiting and API-key auth in minutes. 

## Features

- Supports Swagger 2.0, OpenAPI 3.x.x 

- Works with any framework or with no framework

- Allows making API calls

- Better Usability, 

  - all Models and Examples are expanded by default, eliminates the need to click and reveal.

  - Request fields are pre-populated with sample data

  - Takes only one click to make an API call

  - Request and response can be placed side-by-side for easy comparison

- Branding and Personalization features makes it easy to follow any style guide

  - Comes with 2 Themes (Dark and Light)

  - Replace default logo with yours

  - Typography, allows changing fonts

  - Allows changing text-color, button-color, header-color and color of other UI elements

- Plenty of customization options 

  - Add external contents at the top and bottom of the document,  you may add images, link, text, forms etc

  - Allows disabling API calling feature

  - Hide the header, so the user can't load any other OpenAPI Spec

  - Hide Authentication and provide your own pre-generated api-key 

  - Embed it inside another HTML document

  - Use it inside another framework (react, vue, angular, lit-element)

  - Use JavaScript to change its attributes, and it will react to those changes

  - Style the element with standard css (change padding, position, border, margin )

- Lightweight and fast

- Load local json spec from the disk

- Supported on Chrome, FireFox and Safari. (Not yet tested on Edge)

## Documentation

[Check out the usage and demos](https://rapi-doc.github.io/RapiDoc/)

## Examples

[Examples and Test cases](https://rapi-doc.github.io/RapiDoc/list.html)

## Build Process

```bash

# Clone / Download the project then

npm install

# build will generate rapidoc-min.js, this is the only file you will need.

# use it in the script tag of your html