RapiDoc - Vaadin Add-on Directory

Name: RapiDoc
Availability: InStock
Author: mrin9

RapiDoc - Custom-Element for OpenAPI Spec

# 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](https://mrin9.github.io/RapiDoc/) ## Build Process We recommend `yarn` over `npm` as we use yarn [resolutions](https://yarnpkg.com/lang/en/docs/selective-version-resolutions/) to keep the bundle size smaller. As of this writing this feature is not supported in npm natively ```bash # 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 yarn build # for developement use yarn serve (this will start an webserver at port 8080, then navigate to localhost:8080) yarn serve ```

View on NPM
View on GitHub

RapiDoc version 1.0.0-rc.0
### Dependencies * @webcomponents/webcomponentsjs#^2.2.3 * axios#^0.18.0 * lit-element#latest * lit-html#latest * marked#^0.6.0 * swagger-parser#^6.0.3 * swagger2openapi#^4.0.1

RapiDoc version 1.0.0-rc.1
### Dependencies * @webcomponents/webcomponentsjs#^2.2.3 * axios#^0.18.0 * lit-element#latest * lit-html#latest * marked#^0.6.0 * swagger-parser#^6.0.3 * swagger2openapi#^4.0.1

RapiDoc version 1.0.0-rc.2
### Dependencies * @webcomponents/webcomponentsjs#^2.2.3 * axios#^0.18.0 * lit-element#latest * lit-html#latest * marked#^0.6.0 * swagger-parser#^6.0.3 * swagger2openapi#^4.0.1

RapiDoc version 1.0.0
### Dependencies * json-schema-ref-parser#^6.0.3 * lit-element#latest * lit-html#latest * lodash.clonedeep#^4.5.0 * lodash.debounce#^4.0.8 * marked#^0.6.0 * swagger2openapi#^5.0.1

RapiDoc version 1.0.1
### Dependencies * json-schema-ref-parser#^6.0.3 * lit-element#latest * lit-html#latest * lodash.clonedeep#^4.5.0 * lodash.debounce#^4.0.8 * marked#^0.6.0 * swagger2openapi#^5.0.1

RapiDoc version 1.0.2
### Dependencies * json-schema-ref-parser#^6.0.3 * lit-element#2.0.0-rc.3 * lit-html#1.0.0-rc.2 * lodash.clonedeep#^4.5.0 * lodash.debounce#^4.0.8 * marked#^0.6.0 * swagger2openapi#^5.0.2

RapiDoc version 1.0.3
### Dependencies * json-schema-ref-parser#^6.0.3 * lit-element#2.0.0-rc.3 * lit-html#1.0.0-rc.2 * lodash.clonedeep#^4.5.0 * lodash.debounce#^4.0.8 * marked#^0.6.0 * swagger2openapi#^5.1.0

RapiDoc version 1.0.4
### Dependencies * json-schema-ref-parser#^6.0.3 * lit-element#2.0.0-rc.3 * lit-html#1.0.0-rc.2 * lodash.clonedeep#^4.5.0 * lodash.debounce#^4.0.8 * marked#^0.6.0 * swagger2openapi#^5.1.0

RapiDoc version 2.0.0
### Dependencies * json-schema-ref-parser#^6.0.3 * lit-element#2.0.0-rc.5 * lit-html#1.0.0-rc.2 * lodash.clonedeep#^4.5.0 * lodash.debounce#^4.0.8 * marked#^0.6.0 * swagger2openapi#^5.1.0

RapiDoc version 2.0.1
### Dependencies * json-schema-ref-parser#^6.0.3 * lit-element#2.0.0-rc.5 * lit-html#1.0.0-rc.2 * lodash.clonedeep#^4.5.0 * lodash.debounce#^4.0.8 * marked#^0.6.0 * swagger2openapi#^5.1.0

RapiDoc version 2.0.2
### Dependencies * json-schema-ref-parser#^6.0.3 * lit-element#2.0.1 * lit-html#1.0.0 * lodash.clonedeep#^4.5.0 * lodash.debounce#^4.0.8 * marked#^0.6.0 * swagger2openapi#^5.2.0

RapiDoc version 3.0.0
### Dependencies * json-schema-ref-parser#^6.0.3 * lit-element#2.0.1 * lit-html#1.0.0 * lodash.clonedeep#^4.5.0 * lodash.debounce#^4.0.8 * marked#^0.6.0 * swagger2openapi#^5.2.0

RapiDoc version 3.0.1
### Dependencies * json-schema-ref-parser#^6.0.3 * lit-element#2.0.1 * lit-html#1.0.0 * lodash.clonedeep#^4.5.0 * lodash.debounce#^4.0.8 * marked#^0.6.0 * swagger2openapi#^5.2.0

RapiDoc version 3.0.2
### Dependencies * json-schema-ref-parser#^6.0.3 * lit-element#2.0.1 * lit-html#1.0.0 * lodash.clonedeep#^4.5.0 * lodash.debounce#^4.0.8 * marked#^0.6.0 * swagger2openapi#^5.2.0

RapiDoc version 3.0.3
### Dependencies * json-schema-ref-parser#^6.0.3 * lit-element#2.0.1 * lit-html#1.0.0 * lodash.clonedeep#^4.5.0 * lodash.debounce#^4.0.8 * marked#^0.6.0 * swagger2openapi#^5.2.0

RapiDoc version 3.0.4
### Dependencies * json-schema-ref-parser#^6.0.3 * lit-element#2.0.1 * lit-html#1.0.0 * lodash.clonedeep#^4.5.0 * lodash.debounce#^4.0.8 * marked#^0.6.0 * swagger2openapi#^5.2.1

RapiDoc version 3.1.0
### Dependencies * json-schema-ref-parser#^6.0.3 * lit-element#2.0.1 * lit-html#1.0.0 * lodash.clonedeep#^4.5.0 * lodash.debounce#^4.0.8 * marked#^0.6.0 * swagger2openapi#^5.2.1

RapiDoc version 3.1.1
### Dependencies * json-schema-ref-parser#^6.1.0 * lit-element#2.0.1 * lit-html#1.0.0 * lodash.clonedeep#^4.5.0 * lodash.debounce#^4.0.8 * marked#^0.6.1 * swagger2openapi#^5.2.3

RapiDoc version 3.2.0
### Dependencies * json-schema-ref-parser#^6.1.0 * lit-element#2.0.1 * lit-html#1.0.0 * lodash.clonedeep#^4.5.0 * lodash.debounce#^4.0.8 * marked#^0.6.1 * swagger2openapi#^5.2.3

RapiDoc version 3.2.2
### Dependencies * json-schema-ref-parser#^6.1.0 * lit-element#2.0.1 * lit-html#1.0.0 * lodash.clonedeep#^4.5.0 * lodash.debounce#^4.0.8 * marked#^0.6.1 * swagger2openapi#^5.2.3

RapiDoc version 4.0.0
### Dependencies * json-schema-ref-parser#^6.1.0 * lit-element#2.0.1 * lit-html#1.0.0 * lodash.clonedeep#^4.5.0 * lodash.debounce#^4.0.8 * marked#^0.6.1 * swagger2openapi#^5.2.3

RapiDoc version 4.1.0
### Dependencies * json-schema-ref-parser#^6.1.0 * lit-element#2.0.1 * lit-html#1.0.0 * lodash.clonedeep#^4.5.0 * lodash.debounce#^4.0.8 * marked#^0.6.1 * swagger2openapi#^5.2.3

RapiDoc version 4.2.0
### Dependencies * json-schema-ref-parser#^6.1.0 * lit-element#2.0.1 * lit-html#1.0.0 * lodash.clonedeep#^4.5.0 * lodash.debounce#^4.0.8 * marked#^0.6.1 * swagger2openapi#^4.0.2

RapiDoc version 4.2.1
### Dependencies * json-refs#^3.0.12 * lit-element#2.0.1 * lit-html#1.0.0 * marked#^0.6.1 * swagger2openapi#^4.0.2

RapiDoc version 4.2.2
### Dependencies * json-refs#^3.0.12 * lit-element#2.1.0 * lit-html#1.0.0 * marked#^0.6.1 * swagger2openapi#^4.0.2

RapiDoc version 4.2.3
### Dependencies * json-refs#^3.0.12 * lit-element#2.1.0 * lit-html#1.0.0 * marked#^0.6.1 * swagger2openapi#^4.0.2

RapiDoc version 4.2.4
### Dependencies * json-refs#^3.0.12 * lit-element#2.1.0 * lit-html#1.0.0 * marked#^0.6.1 * swagger2openapi#^4.0.2

RapiDoc version 4.2.5
### Dependencies * json-refs#^3.0.12 * lit-element#2.1.0 * lit-html#1.0.0 * marked#^0.6.1 * swagger2openapi#^4.0.2

RapiDoc version 4.2.6
### Dependencies * json-refs#^3.0.12 * lit-element#2.1.0 * lit-html#1.0.0 * marked#^0.6.1 * swagger2openapi#^4.0.2

RapiDoc version 4.2.7
### Dependencies * json-refs#^3.0.13 * lit-element#2.1.0 * lit-html#1.0.0 * marked#^0.6.2 * swagger2openapi#^4.0.2

RapiDoc version 4.2.10
### Dependencies * json-refs#^3.0.13 * lit-element#2.1.0 * lit-html#1.0.0 * marked#^0.6.2 * swagger2openapi#^4.0.2

RapiDoc version 4.2.9
### Dependencies * json-refs#^3.0.13 * lit-element#2.1.0 * lit-html#1.0.0 * marked#^0.6.2 * swagger2openapi#^4.0.2

RapiDoc version 4.2.11
### Dependencies * json-refs#^3.0.13 * lit-element#2.1.0 * lit-html#1.0.0 * marked#^0.6.2 * swagger2openapi#^4.0.2

RapiDoc version 4.3.0
### Dependencies * json-refs#^3.0.13 * lit-element#2.1.0 * lit-html#1.0.0 * marked#^0.6.2 * swagger2openapi#^4.0.2

RapiDoc version 5.0.0
### Dependencies * json-refs#^3.0.13 * lit-element#2.1.0 * lit-html#1.0.0 * marked#^0.6.2 * swagger2openapi#^4.0.2

RapiDoc version 5.0.1
### Dependencies * json-refs#^3.0.13 * lit-element#2.1.0 * lit-html#1.0.0 * marked#^0.6.2 * swagger2openapi#^4.0.2

RapiDoc version 5.0.2
### Dependencies * json-refs#^3.0.13 * lit-element#2.1.0 * lit-html#1.0.0 * marked#^0.6.2 * swagger2openapi#^4.0.2

RapiDoc version 5.0.3
### Dependencies * json-refs#^3.0.13 * lit-element#2.1.0 * lit-html#1.0.0 * marked#^0.6.2 * swagger2openapi#^4.0.2

RapiDoc 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