RapiDoc - Custom-Element for OpenAPI Spec
Branch: master
Clone or download
Latest commit b1f1bbe Feb 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs updated readme Feb 18, 2019
src minor fixes to json model tree ui Feb 17, 2019
.eslintrc Minor fixes and style changes Feb 14, 2019
.gitignore initial commit Jan 16, 2019
LICENSE.txt Added License Jan 29, 2019
README.md updated readme Feb 15, 2019
index.html minor fixes to json model tree ui Feb 17, 2019
logo.png Added new example Jan 18, 2019
package.json Updated example Feb 17, 2019
polymer.json initial commit Jan 16, 2019
webpack.config.js minor fixes to json model tree ui Feb 17, 2019
yarn.lock

README.md

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

Roadmap

  • 👍 Get the bundle size even smaller (~ 125 Kb gzipped)
  • 👍 Provide a console to try out the APIs
  • 👍 HTTP and Token based Authentication process
  • 👍 Allow replacing default logo
  • 👍 Allow embeding custom HTML content
  • Enable OAuth
  • Search API Functionality