Skip to content
Generates a command-line interface for any Swagger Specification
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example Added example image Aug 8, 2014
src
.gitignore 🌅 Aug 8, 2014
LICENSE-APACHE2
README.md
package.json

README.md

Swagger CLI Client

Generates a command-line interface for any Swagger Specification so you can do things like:

Example usage

Usage

This intended to be embedded within a wrapper application which can provide it the schema object (which is generated using fetch-swagger-schema). For example, here's the petstore-cli file:

#!/usr/bin/env node

var swaggerCli = require('../'),
  schema = require('./petstore-schema.json');

swaggerCli(schema);

To create a cli app for your schema, just require your schema instead of the petstore schema.

Auth lookup strategy

By default the cli will first use the --auth param (if defined), then it'll use the <appname>_AUTH (e.g., PETSTORECLI_AUTH) env variable (if defined), and finally a yaml/json file called .<app-name> (e.g. ~/.petstore-cli which may contain "auth: MY_TOKEN").

Overriding the base path

You can override your api base path via the same lookup strategy as auth keys, this is useful for testing and development. Pass in --basePathOverride <path> or defined a <app-name>_BASE_PATH or a basePath key-value pair in the .<app-name> config file.

You can’t perform that action at this time.