search

transportapi / api-console

A Web Component for an interactive REST console based on RAML files
Other
0 stars 0 forks source link

readme

RAML Console

Build Status

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.

Using the console

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.

Including the console directly

  1. Include the packaged CSS and JS in your document

    <head>
  …
  <link href="https://github.com/transportapi/api-console/blob/master/styles/vendor.css" rel="stylesheet" type="text/css">
  <link rel="stylesheet" href="https://github.com/transportapi/api-console/blob/master/path/to/dist/styles/light-theme.css" type="text/css" />
</head>
<body ng-app="ramlConsoleApp" ng-cloak>
  …
  <script src="https://github.com/transportapi/api-console/raw/master/path/to/dist/scripts/vendor.js"></script>
  <script type="text/javascript" src="https://github.com/transportapi/api-console/raw/master/scripts/api-console.js"></script>
  <script type="text/javascript">
    $.noConflict();
  </script>
</body>

  2. Include the <raml-console> directive, specifying your RAML as a src attribute.

  3. Please ensure that the container for the console directive provides the CSS properties overflow: auto and position: relative.

Caveats

CSS Conflicts

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.

JS Conflicts

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.

Including the console via an iframe

  1. Within the page that you would like to include the console into, add the following:

    <iframe src="https://github.com/transportapi/api-console/raw/master/path/to/dist/index.html?raml=path/to/your.api.raml"/>

Caveats

Sizing

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.

General considerations

  1. 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.
  2. 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.

Configuration

Proxying

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

OAuth 2

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.

Single View Mode

In Single View mode you will be able to see only documentation or try-it. 

<raml-console src="https://github.com/transportapi/api-console/raw/master/path-to-raml" single-view></raml-console>

Theme Switcher

Theme Switcher can be disable if needed by adding the following setting:

<raml-console src="https://github.com/transportapi/api-console/raw/master/path-to-raml" disable-theme-switcher></raml-console>

Disabling Client Generator

Raml client generator can be disable if needed by adding the following setting:

<raml-console src="https://github.com/transportapi/api-console/raw/master/path-to-raml" disable-raml-client-generator></raml-console>

Resources collapsed

Resources can be collapsed if needed by adding the following setting:

<raml-console src="https://github.com/transportapi/api-console/raw/master/path-to-raml" resources-collapsed></raml-console>

Documentation collapsed

Documentation can be collapsed if needed by adding the following setting:

<raml-console src="https://github.com/transportapi/api-console/raw/master/path-to-raml" documentation-collapsed></raml-console>

Development

Prerequisites

To run the console, you'll need the following:

First Time Setup

  1. Install Sass - gem install sass
  2. Install grunt-cli globally - npm install -g grunt-cli
  3. Install bower globally - npm install -g bower
  4. Install the console's NPM packages - npm install
  5. Install the console's Bower packages - bower install

Running the server

$ grunt
$ open http://localhost:9000

Testing

Prerequisites

To run tests, you'll need the following:

First Time Setup

  1. Install Sass - gem install sass
  2. Install grunt-cli globally - npm install -g grunt-cli
  3. Install protractor globally - npm install -g protractor
  4. Install the console's NPM packages - npm install
  5. Run node_modules/grunt-protractor-runner/node_modules/protractor/bin/webdriver-manager update

Running Tests

$ grunt regression

Contributor's Agreement

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