You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-22Lines changed: 24 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,29 +8,31 @@ MuleSoft's API Console is a full-fledged API documentation tool that generates m
8
8
9
9
## API console 5.0 is here!
10
10
11
-
Great news! Next version of API console is here! The upgrade includes new design, new data model and and build process that allows reduce size of the console.
11
+
Great news! The next version of API console is here! The upgrade includes new design, new data model and and build process that allows to reduce the size of the console.
12
12
13
13
### AMF (AML Modeling Framework) support
14
14
15
15
We are working very hard to deliver first in class solutions for API documentation.
16
-
MuleSoft's AMF allows to parse any* API document and produces common data model. API console consumes this model instead of RAML JS parser's.
17
16
18
-
\* Currently AMF supports RAML 0.8, RAML 1.0, OAS 2.0 and OAS 3.0. It can be extended by defining new vocabulary to support other API spec formats.
17
+
MuleSoft's AMF allows to parse any* API document and produces common data model. API console consumes this model instead of RAML JS parsers.
18
+
19
+
\* Currently, AMF supports RAML 0.8, RAML 1.0, OAS 2.0 and OAS 3.0. It can be extended by defining new vocabularies to support other API spec formats.
19
20
20
21
### Redesign
21
22
22
-
New API console has been tested with users and the redesigned, then tested with used again and then redesigned again to ensure we offer best in class API documentation tools.
23
-
New navigation allows understand structure of the API better and users can navigate through the documentation faster.
23
+
The new API console has undergone several rounds of testing and redesign to ensure that we offer best in class API documentation tools.
24
+
25
+
The revamped navigation allows to better understand the structure of the API, and users can navigate through the documentation faster.
24
26
25
-
New documentation page focuses on presenting the information which is the API and not features of the app itself. This allows users to learn faster and be more productive.
27
+
The new documentation pages focus on presenting the API and not features of the app itself. This allows users to learn faster and be more productive.
26
28
27
-
### Re-build
29
+
### Rebuild
28
30
29
-
New [build tools][] allows you to customize the bundle to your needs and possibly reduce size of the console even more than when using default settings. Check out "Building the console" section for more information.
31
+
New [build tools][] allows you to customize the bundle to your needs and possibly reduce the size of the console even more than when using default settings. Check out the "Building the console" section for more information.
30
32
31
33
## Introduction
32
34
33
-
API console is an web application created on top of the [Web Components specifications](https://www.webcomponents.org/introduction) and powered by the [Polymer library](https://www.polymer-project.org/). Familiarity with Polymer isn't necessary to use the console.
35
+
API console is a web application created on top of the [Web Components specifications](https://www.webcomponents.org/introduction) and powered by the [Polymer library](https://www.polymer-project.org/). Familiarity with Polymer isn't necessary to use the console.
34
36
35
37
The following sections briefly describe how to build and use the console. For more information, see the [docs](docs) directory in this repository.
36
38
@@ -62,11 +64,11 @@ To build the API Console as a standalone application use our [build tools][].
62
64
63
65
### Using API components
64
66
65
-
This is advanced option for developers to embed the console or one of it's components into existing web page.
67
+
This is an advanced option for developers to embed the console or one of its components into existing web page.
66
68
67
-
API console is a web component. This mean it can be used in any web environments (browser, Chrome frame, Electron app etc). Also it can be mixed with any framework as it does not reference other frameworks.
69
+
API console is a web component. This mean it can be used in any web environments (browser, Chrome frame, Electron app, etc.). Also, it can be mixed with any framework, as it does not reference other frameworks.
68
70
69
-
This version of the console still works with `bower` as a dependency manager as it works with HTML imports. Next version will work with ES6 module imports which supports npm as a dependency management system.
71
+
This version of the console still works with `bower` as a dependency manager, as it works with HTML imports. Next version will work with ES6 module imports, which supports npm as a dependency management system.
70
72
71
73
First, use [Bower][] to install the console and its dependencies:
72
74
@@ -88,13 +90,13 @@ Finally use the HTML tag:
88
90
</body>
89
91
```
90
92
91
-
See complete documentation about how to import sources into your web page in the [api console element docs][]. Also, if you are a developer you can check out [demo application source code][].
93
+
See the complete documentation on how to import sources into your web page in the [api console element docs][]. Also, if you are a developer check out the[demo application source code][].
92
94
93
-
You can also build API Console as a embeddable HTML element using one of our [build tools][].
95
+
You can also build API Console as an embeddable HTML element using one of our [build tools][].
94
96
95
97
## API Console configuration options
96
98
97
-
Configuration options differ from the previous version. Because API Console is a (custom) HTML element its configuration is based on HTML attributes. You can pass values as an attribute value, or use a boolean option by simply setting the attribute. Configuration from JavaScript code is based on setting a JavaScript property as the attribute name on the element. If the attribute name contains dashes then make the property name [camel case][].
99
+
Configuration options differ from the previous version. Because API Console is a (custom) HTML element, its configuration is based on HTML attributes. You can pass values as an attribute value, or use a boolean option by simply setting the attribute. Configuration from JavaScript code is based on setting a JavaScript property as the attribute name on the element. If the attribute name contains dashes, then convert the property name to[camel case][].
98
100
99
101
Example:
100
102
@@ -110,11 +112,11 @@ console.narrow = true;
110
112
console.appendHeaders='x-api-key: 1234';
111
113
```
112
114
113
-
See the full list of API Console configuration options in the [configuring the api console][] document.
115
+
See the full list of API Console configuration options in [configuring the api console][].
114
116
115
117
## Build tools
116
118
117
-
A set of build tools is included to help you create API Console from the RAML file. Build tools are configured to produce a production optimized version of API Console. The build tools can generate both standalone and embeddable version of the console. You can also configure data source strategy (RAML, JSON or inline JSON as a data source).
119
+
A set of build tools is included to help you create API Console from the API specification file. Build tools are configured to produce a production optimized version of API Console. The build tools can generate both standalone and embeddable version of the console. You can also configure the data source strategy (RAML, JSON, or inline JSON as a data source).
118
120
119
121
The following build tools are available:
120
122
@@ -123,9 +125,9 @@ The following build tools are available:
123
125
*`api-console-builder`
124
126
*`amf-client-js`
125
127
126
-
Depending on your needs you can choose whether you want to use a CLI tool or a node module.
128
+
Depending on your needs, you can choose whether you want to use a CLI tool or a node module.
127
129
128
-
Build tools can be helpful in the CI process to automate the documentation release cycle. See the [build tools][] documentation for more information and build strategies.
130
+
Build tools can be helpful in the CI process to automate documentation release cycles. See the [build tools][] documentation for more information and build strategies.
129
131
130
132
## Theming
131
133
API Console supports theming and comes with a default theme. You can create your own theme. For example, you can tweak the style of the console to match your corporate style guide.
@@ -136,7 +138,7 @@ Theming is based on CSS variables and CSS mixins. Basic concepts of using the va
136
138
137
139
Cross-origin resource sharing (CORS) allows sharing resources from one domain to other domains. Browsers block all requests to other domains but with a special set of headers authors can allow other domains to request a resource. For more information, see the [CORS Wiki][].
138
140
139
-
If your API does not allow CORS and you hosting your API documentation in different domain then API Console won't be able to make a request to an endpoint. API Console currently supports 3 ways of dealing with this issue:
141
+
If your API does not allow CORS and you are hosting your API documentation in different domain, API Console won't be able to make a request to an endpoint. API Console currently supports three ways of dealing with this issue:
140
142
141
143
- by installing the __API Console Chrome extension__
142
144
- by setting up a __proxy server__
@@ -146,7 +148,7 @@ Read our [CORS guideline][] for more information about each of these solutions.
146
148
147
149
## Preview and development
148
150
149
-
The API Console is a custom element that serves as a shell element for other custom web components. To develop the API Console most probably you'd have to develop one of over a hundred other web components that creates the console. All the elements are described in [the elements catalog][the elements catalogue].
151
+
The API Console is a custom element that serves as a shell element for other custom web components. All the elements are described in [the elements catalog][the elements catalogue].
150
152
151
153
1. Clone the element.
152
154
```
@@ -169,7 +171,7 @@ bower install && npm i
169
171
polymer serve --open
170
172
```
171
173
172
-
5. If you are planning to parse own RAML/OAS file then additionally run this command to run AMF parsing service for the demo page:
174
+
5. If you are planning to parse your own RAML/OAS file, run this command to run AMF parsing service for the demo page:
0 commit comments