An API console for RAML (Restful Api Modeling Language) documents. The RAML Console allows browsing of API documentation and in-browser testing of API methods.
There are two ways you can include the console: directly, or within an iframe. The direct method is seamless but has the potential of CSS and JS conflicts. Using an iframe avoids conflicts, but has its own quirks noted below.
-
Include the packaged CSS and JS in your document
<head> … <link href="styles/vendor.css" rel="stylesheet" type="text/css"> <link rel="stylesheet" href="path/to/dist/styles/light-theme.css" type="text/css" /> </head> <body ng-app="ramlConsoleApp" ng-cloak> … <script src="path/to/dist/scripts/vendor.js"></script> <script type="text/javascript" src="scripts/api-console.js"></script> <script type="text/javascript"> $.noConflict(); </script> </body> -
Include the
<raml-console-loader>directive, specifying your RAML as asrcattribute. -
Please ensure that the container for the console directive provides the CSS properties
overflow: autoandposition: relative.
The CSS for the console is namespaced so that it won't affect other parts of the page it's included on. However, general styles you have (such as on h1s) may inadvertently bleed into the console.
The console's javascript includes various dependencies, for example AngularJS and jQuery. If your document requires different versions or includes conflicting libraries, your page may break.
-
Within the page that you would like to include the console into, add the following:
<iframe src="path/to/dist/index.html?raml=path/to/your.api.raml"/>
You will need to specify a fixed height for the iframe that fits into the design of your page. Since iframes do not automatically resize to fit content, the user may have to scroll within the iframe.
- Your RAML document needs to be hosted on the same domain as the console, or on a domain that allows CORS requests from your domain.
- To use Try It functionality within the console, your API needs to enable CORS from the console's domain, or you need to use a proxy.
- To load a RAML from Gitlab (by specifying group/repository/tag/path), you'll need to forward your Gitlab (
http://<server>/gitlab) to the same domain as the console. By default, behind '/git'. (i.e : let's consider you provide your API console throughhttp://<server>:<port>/api, then your gitlab will be available athttp://<server>:<port>/api).
A Raml file path can be read from the query parameter raml=path-to-raml. (don't forget to provide a same domain URL)
for example :
http://<server>/api/index.html?raml=http://<server>/api/git/mygroup/myrepo/raw/master/test.raml
A Raml file can also be loaded from gitlab by providing query parameter ?group=GG&repository=RR&branch=BB&path=PP.
http://<server>/api/index.html?group=mygroup&repository=myrepo&tag=master&path=test.raml
A proxy for Try It can be provided after loading the console JavaScript. For example:
RAML.Settings.proxy = 'http://www.someproxy.com/somepath/'
Given the above, trying a GET to http://www.someapi.com/resource would get
http://www.someproxy.com/somepath/http://www.someapi.com/resource
A redirect URI for OAuth 2 can be provided in a similar manner:
RAML.Settings.oauth2RedirectUri = 'http://www.raml.org/console/'
Given the above, OAuth 2 requests would redirect back to that URL.
Add the following in a similar manner as proxying or OAuth 2.0 to ignore markdown line breaks as they are:
RAML.Settings.marked.breaks = false
In Single View mode you will be able to see only documentation or try-it.
<raml-console-loader src="path-to-raml" single-view></raml-console-loader>
Theme Switcher can be disable if needed by adding the following setting:
<raml-console-loader src="path-to-raml" disable-theme-switcher></raml-console-loader>
Raml client generator can be disable if needed by adding the following setting:
<raml-console-loader src="path-to-raml" disable-raml-client-generator></raml-console-loader>
Resources can be collapsed if needed by adding the following setting:
<raml-console-loader src="path-to-raml" resources-collapsed></raml-console-loader>
Documentation can be collapsed if needed by adding the following setting:
<raml-console-loader src="path-to-raml" documentation-collapsed></raml-console-loader>
Unsafe Markdown will be disable by default, if you want to allow unsafe content check the following example:
<raml-console-loader src="path-to-raml" allow-unsafe-markdown></raml-console-loader>
Try-it will be enable by default, if you want to disable Try-it you can do that by adding the following setting:
<raml-console-loader src="path-to-raml" disable-try-it></raml-console-loader>
To run the console, you'll need the following:
- Install Sass -
gem install sass - Install grunt-cli globally -
npm install -g grunt-cli - Install bower globally -
npm install -g bower - Install the console's NPM packages -
npm install - Install the console's Bower packages -
bower install
$ grunt
$ open http://localhost:9000
To run tests, you'll need the following:
- Install Sass -
gem install sass - Install grunt-cli globally -
npm install -g grunt-cli - Install protractor globally -
npm install -g protractor - Install the console's NPM packages -
npm install - Run
node_modules/grunt-protractor-runner/node_modules/protractor/bin/webdriver-manager update
In order to check Git group and repository's availability, API console uses Gitlab's API.
Your Gitlab API Token has to be provided in raml-initializer.js inside :
var getGitAccessToken = function() {
return 'your Gitlab API token here';
}; Also make sure that the account associated is member (Guest is enough) of the groups you want to get the raml from.
$ grunt regression
To contribute source code to this repository, please read our contributor's agreement, and then execute it by running this notebook and following the instructions: https://api-notebook.anypoint.mulesoft.com/notebooks/#380297ed0e474010ff43