swaggerhub-cli

SwaggerHub CLI

A command-line interface for SwaggerHub API (https://api.swaggerhub.com). Supports SwaggerHub SaaS and On-Premise.

• Requirements
• Installation
• Setup
• Usage
• Commands
• Contributing

Requirements

Node.js 10 or later.

Installation

$ npm i -g swaggerhub-cli

Setup

$ swaggerhub configure
? SwaggerHub URL: https://api.swaggerhub.com
? API Key: <your-api-key>

SwaggerHub URL defaults to the SaaS version, https://api.swaggerhub.com. The URL can be reset using the configure command

Alternatively, these values can be set using the SWAGGERHUB_URL and SWAGGERHUB_API_KEY environment variables. These take precedence over config values.

Usage

$ swaggerhub COMMAND
running command...
$ swaggerhub (-v|--version|version)
swaggerhub/0.1.2 darwin-x64 node-v12.13.0
$ swaggerhub --help [COMMAND]
USAGE
  $ swaggerhub COMMAND
...

Commands

• swaggerhub api:create OWNER/API_NAME/[VERSION]
• swaggerhub api:get OWNER/API_NAME/[VERSION]
• swaggerhub api:publish OWNER/API_NAME/VERSION
• swaggerhub api:setdefault OWNER/API_NAME/VERSION
• swaggerhub api:unpublish OWNER/API_NAME/VERSION
• swaggerhub api:update OWNER/API_NAME/[VERSION]
• swaggerhub configure
• swaggerhub help [COMMAND]

swaggerhub api:create

creates a new API / API version from a YAML/JSON file

USAGE
  $ swaggerhub api:create OWNER/API_NAME/[VERSION]

ARGUMENTS
  OWNER/API_NAME/[VERSION]  API to create in SwaggerHub

OPTIONS
  -f, --file=file              (required) file location of API to create
  -h, --help                   show CLI help
  --visibility=public|private  [default: private] visibility of API in SwaggerHub

DESCRIPTION
  The API version from the file will be used unless the version is specified in the command argument.
  An error will occur if the API version already exists.

EXAMPLES
  swaggerhub api:create organization/api/1.0.0 --file api.yaml --visibility public
  swaggerhub api:create organization/api --file api.yaml

See code: src/commands/api/create.js

swaggerhub api:get

fetches an API definition

USAGE
  $ swaggerhub api:get OWNER/API_NAME/[VERSION]

ARGUMENTS
  OWNER/API_NAME/[VERSION]  SwaggerHub API to fetch

OPTIONS
  -h, --help      show CLI help
  -j, --json      returns the API in JSON format.
  -r, --resolved  gets the resolved API definition.

DESCRIPTION
  When VERSION is not included in the argument, the default version will be returned.
  Returns the API in YAML format by default.

EXAMPLES
  swaggerhub api:get organization/api
  swaggerhub api:get organization/api/1.0.0 --json

See code: src/commands/api/get.js

swaggerhub api:publish

publish an API version

USAGE
  $ swaggerhub api:publish OWNER/API_NAME/VERSION

ARGUMENTS
  OWNER/API_NAME/VERSION  API identifier

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  swaggerhub api:publish organization/api/1.0.0

See code: src/commands/api/publish.js

swaggerhub api:setdefault

set the default version of an API

USAGE
  $ swaggerhub api:setdefault OWNER/API_NAME/VERSION

ARGUMENTS
  OWNER/API_NAME/VERSION  API identifier

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  swaggerhub api:setdefault organization/api/2.0.0

See code: src/commands/api/setdefault.js

swaggerhub api:unpublish

unpublish an API version

USAGE
  $ swaggerhub api:unpublish OWNER/API_NAME/VERSION

ARGUMENTS
  OWNER/API_NAME/VERSION  API identifier

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  swaggerhub api:unpublish organization/api/1.0.0

See code: src/commands/api/unpublish.js

swaggerhub api:update

update an API version

USAGE
  $ swaggerhub api:update OWNER/API_NAME/[VERSION]

ARGUMENTS
  OWNER/API_NAME/[VERSION]  API to update in SwaggerHub

OPTIONS
  -f, --file=file              (required) file location of API to update
  -h, --help                   show CLI help
  --visibility=public|private  [default: private] visibility of API in SwaggerHub

DESCRIPTION
  The API version from the file will be used unless the version is specified in the command argument.
  An error will occur if the API version does not exist.

EXAMPLES
  swaggerhub api:update organization/api --file api.yaml
  swaggerhub api:update organization/api/1.0.0 --file api.json

See code: src/commands/api/update.js

swaggerhub configure

configure application settings

USAGE
  $ swaggerhub configure

DESCRIPTION
  Enter the SwaggerHub URL - default is https://api.swaggerhub.com
  Enter the API Key - this can be retrieved from https://app.swaggerhub.com/settings/apiKey
  You can set these as environment variables: SWAGGERHUB_URL, SWAGGERHUB_API_KEY. These take priority over config 
  settings.

See code: src/commands/configure.js

swaggerhub help [COMMAND]

display help for swaggerhub

USAGE
  $ swaggerhub help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

Contributing

The SwaggerHub CLI is currently in an active development phase—we will not be accepting Pull Requests at this time. If you’ve found any bugs or typos, or have a feature requests or general feedback you’d like to share, please open an issue and let us know.

testing changelog