|
3 | 3 | ### Features
|
4 | 4 | - Supports swagger 2.0 and OpenAPI 3.0
|
5 | 5 | - Works with any framework
|
6 |
| -- Allows to make API calls |
| 6 | +- Programmatically control using JavaScript - change its attributes, and it will react to those changes |
| 7 | +- Integrated console to make API calls from the spec |
| 8 | +- Allows to load JSON spec from URL and from Local Disk |
7 | 9 | - Better Usability,
|
8 |
| - - all Models and Examples are expanded by default, eliminates the need to click and reveal. |
9 |
| - - Request fields are pre-populated with sample data |
| 10 | + - All models and examples are expanded by default, eliminates the need to click and reveal. |
| 11 | + - Requests and Responses are pre-populated with sample data |
10 | 12 | - Takes only one click to make an API call
|
11 |
| - - Request and response can be placed side-by-side for easy comparison |
| 13 | +- Row and Column layout supported |
| 14 | + - Row: request and response placed side-by-side for easy comparison |
| 15 | + - Column: request and response placed one below the other for narrow screens such as tablets |
12 | 16 | - Branding and Personalization features makes it easy to follow any style guide
|
13 | 17 | - Comes with 2 Themes (Dark and Light)
|
14 | 18 | - Replace default logo with yours
|
15 |
| - - Typography, allows changing fonts |
| 19 | + - Allows changing fonts (Regular and monspaced) |
16 | 20 | - Allows changing text-color, button-color, header-color and color of other UI elements
|
17 | 21 | - Plenty of customization options
|
18 | 22 | - Add external contents at the top and bottom of the document, you may add tables, images, link, text, forms etc
|
19 |
| - - Allows disabling API calling feature |
20 |
| - - Hide the header so the user cant load any other OpenAPI Spec |
| 23 | + - You can disable API calling feature |
| 24 | + - Stop user to load any other API spec by hiding Header |
21 | 25 | - Hide Authentication and provide your own pre-generated api-key
|
22 |
| - - Embed it inside another HTML document |
| 26 | + - Embed it inside another HTML document (no iframes) |
23 | 27 | - Use it inside another framework (react, vue, angular, lit-element)
|
24 |
| - - Programmatically control the element using JavaScript - change its attributes, and it will react to those changes |
25 |
| - - Style the element with standard css (change padding, position, border, margin ) |
| 28 | + - Style the element with standard css (change padding, position, border, margin) |
26 | 29 | - Lightweight and fast (under 125 KB gzipped)
|
27 |
| -- Load local json spec from the disk |
28 | 30 |
|
29 | 31 | ### Quickstart (Use from CDN)
|
30 | 32 | Just copy the below script in an html, and open it in a browser !!!
|
@@ -129,8 +131,7 @@ Just copy the below script in an html, and open it in a browser !!!
|
129 | 131 |
|
130 | 132 |
|
131 | 133 | - Change Attributes using JavaScript ([Demo](example100.html))
|
132 |
| - |
133 |
| -use javascript `Element.setAttribute()` to change the elements attributes and see it reacts to those changes |
| 134 | + use javascript `Element.setAttribute()` to change the elements attributes and see it reacts to those changes |
134 | 135 |
|
135 | 136 | ### Use in a HTML/JS based project
|
136 | 137 |
|
|
0 commit comments