RapiDoc - Custom-Element for OpenAPI Spec

MrinDoc logo

RapiDoc

Custom Eelement for Open-API spec viewing

Features

  • Supports Swagger 2.0 and OpenAPI 3.0
  • Works with any framework or with no framework
  • Allows to make 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 comparision
  • 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 cant 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 (under 125 KB gzipped)
  • Load local json spec from the disk
  • Supported on Chrome, FireFox and Safari. (Not yet tested on Edge)

Documentation

Check out the usage and examples

Build Process

We recommend yarn over npm as we use yarn resolutions to keep the bundle size smaller. As of this writing this feature is not supported in npm natively

# Clone / Download the project then
yarn install

# build will generate rapidoc-min.js, this is the only file you will need.
# use it in the script tag of your html <script type="text/javascript" src="rapidoc-min.js"></script></body>
yarn build 

# for developement use yarn serve (this will start an webserver at port 8080, then navigate to localhost:8080) 
yarn serve

Install

Link to this version
ImportedReleased 29 May 2019MIT License
Framework Support
Browser Independent
Install with
npm install rapidoc"@5.0.4"
Run the above npm command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 5.0.4

Dependencies

  • json-refs#^3.0.13
  • lit-element#2.1.0
  • lit-html#1.0.0
  • marked#^0.6.2
  • swagger2openapi#^4.0.2