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 rel="stylesheet" href="path/to/dist/styles/app.css" type="text/css" /> </head> <body ng-app="ramlConsoleApp" ng-cloak id="raml-console-unembedded"> … <script src="path/to/dist/scripts/vendor.js"></script> <script src="path/to/dist/scripts/app.js"></script> </body> -
Include the
<raml-console>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.
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.
The <raml-console> directive accepts an optional with-root-documentation attribute. If this attribute is omitted, the console will not display root-level documentation in RAML document.
To run the console, you'll need the following:
- 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 server
$ open http://localhost:9000
To run the tests, use grunt:
$ grunt test
To run only a portion of the tests, you can use
$ grunt spec:unit
$ grunt spec:integration
$ grunt scenario
The scenario tests use angular's protractor framework, and run via selenium in firefox. Selenium is automatically downloaded, but you'll need firefox to be installed.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent