Browse and test your Sycle app's APIs.
Below is a simple Sycle application. The explorer is mounted at
var sycle = ;var express = ;var rest = ;var explorer = ;var port = 3000;// create express applicationvar app = ;app;// create sycle applicationvar sapp = ;sappregistry;sapp;sapp;// setup middlewaresvar apiPath = '/api';app;app;console;// start serverapp;
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;app;app;
Options are passed to
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 `app.use('/custom-api-root', rest(sapp));
Sets a path within your application for overriding Swagger UI files.
If present, will search
swaggerDistRootfirst 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.
Additional information about your API. See the spec.
||Required. The title of the application.|
||Required. A short description of the application.|
||A URL to the Terms of Service of the API.|
||An email to be used for API-related correspondence.|
||The license name used for the API.|
||A URL to the license used for the API.|
Sets a different path for the resource listing. You generally shouldn't have to change this.
Default: Read from package.json
Sets your API version. If not present, will read from your app's package.json.