Browse and test your LoopBack app's APIs

Go to file

Samuel Reed e7efa82640 Use `dist` property from swagger-ui package. This removes the hardcoded local `node_modules` lookup for swagger-ui, which will break if the parent installs swagger-ui itself. This is useful if, for example, the latest swagger-ui breaks loopback-explorer, and the parent project wants to install a fixed version in its root.		2014-08-12 09:47:53 -04:00
example	Remove hidden properties from definition.	2014-07-26 12:15:47 -05:00
lib	Fix the type name for a property if model class is used	2014-08-04 23:22:41 -07:00
public	s/accessToken/access_token in authorization key name	2014-07-14 15:40:05 -05:00
test	Fix the type name for a property if model class is used	2014-08-04 23:22:41 -07:00
.gitignore	Initial commit	2013-11-05 09:59:05 -08:00
.jshintrc	Refactoring swagger 1.2 rework.	2014-07-05 14:32:00 -05:00
LICENSE	Update to dual MIT/StrongLoop license	2014-02-17 16:04:12 -08:00
README.md	Allow passing a custom protocol.	2014-07-27 21:44:14 -05:00
index.js	Use `dist` property from swagger-ui package.	2014-08-12 09:47:53 -04:00
package.json	Bump version	2014-08-08 11:21:42 -07:00

README.md

loopback-explorer

Browse and test your LoopBack app's APIs.

Basic Usage

Below is a simple LoopBack application. The explorer is mounted at /explorer.

var loopback = require('loopback');
var app = loopback();
var explorer = require('../');
var port = 3000;

var Product = loopback.Model.extend('product');
Product.attachTo(loopback.memory());
app.model(Product);

app.use('/explorer', explorer(app, {basePath: '/api'}));
app.use('/api', loopback.rest());
console.log("Explorer mounted at localhost:" + port + "/explorer");

app.listen(port);

Advanced Usage

Many aspects of the explorer are configurable.

See options for a description of these options:

// Mount middleware before calling `explorer()` to add custom headers, auth, etc.
app.use('/explorer', loopback.basicAuth('user', 'password'));
app.use('/explorer', explorer(app, {
  basePath: '/custom-api-root',
  swaggerDistRoot: '/swagger',
  apiInfo: {
    'title': 'My API',
    'description': 'Explorer example app.'
  },
  resourcePath: 'swaggerResources',
  version: '0.1-unreleasable'
}));
app.use('/custom-api-root', loopback.rest());

Options

Options are passed to explorer(app, options).

basePath: String

Default: app.get('restAPIRoot') or '/api'.

Sets the API's base path. This must be set if you are mounting your api to a path different than '/api', e.g. with `loopback.use('/custom-api-root', loopback.rest());

protocol: String

Default: null

A hard override for the outgoing protocol (http or https) that is designated in Swagger resource documents. By default, loopback-explorer will write the protocol that was used to retrieve the doc. This option is useful if, for instance, your API sits behind an SSL terminator and thus needs to report its endpoints as https, even though incoming traffic is auto-detected as http.

swaggerDistRoot: String

Sets a path within your application for overriding Swagger UI files.

If present, will search swaggerDistRoot first when attempting to load Swagger UI, allowing you to pick and choose overrides to the interface. Use this to style your explorer or add additional functionality.

See index.html, where you may want to begin your overrides. The rest of the UI is provided by Swagger UI.

apiInfo: Object

Additional information about your API. See the spec.

resourcePath: String

Default: 'resources'

Sets a different path for the resource listing. You generally shouldn't have to change this.

version: String

Default: Read from package.json

Sets your API version. If not present, will read from your app's package.json.