npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@elamajs/api-console

v3.0.25

Published

Api-Console for RAML based app

Downloads

12

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

elama-roelama-roelamaelama

Keywords

api-consoleramlapi

Readme

RAML Console

![Gitter](https://badges.gitter.im/Join Chat.svg)

Build Status Dependency Status DevDependency Status npm version Bower version

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="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>

  2. Include the <raml-console-loader> 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="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.

Markdown line breaks

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

Single View Mode

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

<raml-console-loader src="path-to-raml" options="{ singleView: true }"></raml-console-loader>

Theme Switcher

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

<raml-console-loader src="path-to-raml" options="{ disableThemeSwitcher: true }"></raml-console-loader>

Disabling Client Generator

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

<raml-console-loader src="path-to-raml" options="{ disableRamlClientGenerator: true }"></raml-console-loader>

Resources collapsed

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

<raml-console-loader src="path-to-raml" options="{ resourcesCollapsed: true }"></raml-console-loader>

Documentation collapsed

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

<raml-console-loader src="path-to-raml" options="{ documentationCollapsed: true }"></raml-console-loader>

Allowing Unsafe Markdown

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" options="{ allowUnsafeMarkdown: true }"></raml-console-loader>

Disabling Try-it

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" options="{ disableTryIt: true }"></raml-console-loader>

Multiple Options

Multiple of the options above can be provided. The options need to be expressed in camelcase format:

<raml-console-loader src="path-to-raml" options="{ disableRamlClientGenerator: true, disableTryIt: true }"></raml-console-loader>

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