swaggerhub cliダウンロード - swaggerhub cliソースコードのダウンロード

SwaggerHub CLI

SwaggerHub CLI を使用すると、チームは SwaggerHub を中心に自動化とワークフローを構築できます。チームは、CI/CD パイプラインなどの場所でこれを使用して、新しい API を作成したり、API バージョンを作成および更新したり、他の機能の中で API バージョンを公開済みおよびデフォルトとしてマークしたりできます。各チームには独自のワークフローがあり、SwaggerHub CLI は、チームがニーズに合ったワークフローを構築するのに役立ちます。

要件
インストール
設定
SwaggerHub オンプレミスの追加構成
使用法
コマンド
プラグイン
貢献する

要件

Node.js 18.x 以降。

インストール

$ npm i -g swaggerhub-cli

設定

SwaggerHub CLI は、環境変数またはswaggerhub configureコマンドを通じて構成できます。 CLI は次の環境変数を探します。

SWAGGERHUB_API_KEY (必須) –重要: このキーは安全に保管してください。これは、CLI が認証に使用する SwaggerHub API キーです。 API キーは、SwaggerHub のユーザー設定ページで見つけることができます。
SWAGGERHUB_URL (オプション、デフォルトはhttps://api.swaggerhub.com ) – オンプレミスインストールのお客様は、これをオンプレミス API ( http(s)://{swaggerhub-host}/v1に指定する必要があります。 (バックスラッシュを追加しないでください)。

あるいは、 swaggerhub configureコマンドを使用して、CLI で使用する構成ファイルを作成することもできます。このコマンドでは、必要な構成をセットアップする手順が示されます。

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

環境変数は、このコマンドで作成される設定ファイルよりも優先されます。

SwaggerHub オンプレミスの追加構成

SwaggerHub オンプレミスインスタンスが自己署名またはプライベート署名の SSL 証明書を使用している場合、SwaggerHub CLI にこの証明書を信頼させるには追加の手順が必要です。

デフォルトでは、ルート CA が不明であるため、Node.js は自己署名またはプライベート署名の SSL 証明書を拒否します。 CLI 出力に次のようなエラーが表示されます。

 FetchError: request to https://... failed, reason: self signed certificate

解決策は、 NODE_EXTRA_CA_CERTS環境変数を使用して、Node.js の信頼できるカスタム証明書を指定することです。

まず、信頼できるカスタム証明書を PEM 形式で含む .pem ファイルを作成します。

証明書が自己署名されている (つまり、独自の CA である) 場合は、証明書自体を含めます。
証明書がプライベート CA によって署名されている場合は、CA ルートと中間証明書を任意の順序で含めます。個々の証明書間の空白行は許可されていますが、オプションです。

この PEM ファイルへのパスをNODE_EXTRA_CA_CERTS環境変数に指定します。

macOS/*nix/bash の例:

 export NODE_EXTRA_CA_CERTS=~/Work/extra-ca-certs.pem   # '~' means the home folder of the logged-in user

export NODE_EXTRA_CA_CERTS=$HOME/.ssh/extra-ca-certs.pem

export NODE_EXTRA_CA_CERTS=/Users/username/Work/extra-ca-certs.pem

Windows の例:

 :: Both forward and backslashes are OK
set NODE_EXTRA_CA_CERTS=C:Workextra-ca-certs.pem
set NODE_EXTRA_CA_CERTS=C:/Work/extra-ca-certs.pem

:: You can also define the path itself using environment variables
set NODE_EXTRA_CA_CERTS=%USERPROFILE%extra-ca-certs.pem

使用法

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

コマンド

swaggerhub api:create OWNER/API_NAME/[VERSION]
swaggerhub api:delete 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 api:validate OWNER/API_NAME/[VERSION]
swaggerhub api:validate:download-rules OWNER
swaggerhub api:validate:local
swaggerhub configure
swaggerhub domain:create OWNER/DOMAIN_NAME/[VERSION]
swaggerhub domain:delete OWNER/DOMAIN_NAME/[VERSION]
swaggerhub domain:get OWNER/DOMAIN_NAME/[VERSION]
swaggerhub domain:publish OWNER/DOMAIN_NAME/VERSION
swaggerhub domain:setdefault OWNER/DOMAIN_NAME/VERSION
swaggerhub domain:unpublish OWNER/DOMAIN_NAME/VERSION
swaggerhub domain:update OWNER/DOMAIN_NAME/[VERSION]
swaggerhub help [COMMANDS]
swaggerhub integration:create OWNER/API_NAME/[VERSION]
swaggerhub integration:delete OWNER/API_NAME/VERSION/INTEGRATION_ID
swaggerhub integration:execute OWNER/API_NAME/VERSION/INTEGRATION_ID
swaggerhub integration:get OWNER/API_NAME/VERSION/INTEGRATION_ID
swaggerhub integration:list OWNER/API_NAME/[VERSION]
swaggerhub integration:update OWNER/API_NAME/VERSION/INTEGRATION_ID
swaggerhub plugins
swaggerhub plugins:install PLUGIN...
swaggerhub plugins:inspect PLUGIN...
swaggerhub plugins:install PLUGIN...
swaggerhub plugins:link PLUGIN
swaggerhub plugins:uninstall PLUGIN...
swaggerhub plugins:uninstall PLUGIN...
swaggerhub plugins:uninstall PLUGIN...
swaggerhub plugins:update
swaggerhub project:api:add OWNER/PROJECT_NAME API
swaggerhub project:api:remove OWNER/PROJECT_NAME API
swaggerhub project:create OWNER/PROJECT_NAME
swaggerhub project:delete OWNER/PROJECT_NAME
swaggerhub project:domain:add OWNER/PROJECT_NAME DOMAIN
swaggerhub project:domain:remove OWNER/PROJECT_NAME DOMAIN
swaggerhub project:get OWNER/PROJECT_NAME
swaggerhub project:list [OWNER]
swaggerhub project:member:list OWNER/PROJECT_NAME

`swaggerhub api:create`

YAML/JSON ファイルから新しい API/API バージョンを作成します

 USAGE
  $ swaggerhub api:create OWNER/API_NAME/[VERSION] [--visibility public|private] (--published publish|unpublish
    -f <value>) [--setdefault ] [-h]

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

FLAGS
  -f, --file=<value>     (required) file location of API to create
  -h, --help             Show CLI help.
  --published=<option>   [default: unpublish] sets the lifecycle setting of the API version
                         <options: publish|unpublish>
  --setdefault           sets API version to be the default
  --visibility=<option>  [default: private] visibility of API in SwaggerHub
                         <options: public|private>

DESCRIPTION
  creates a new API / API version from a YAML/JSON file
  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

  $ swaggerhub api:create organization/api/1.0.0 --published=publish --file api.json

  $ swaggerhub api:create organization/api/1.0.0 --setdefault --file api.json

  $ swaggerhub api:create organization/api/1.0.0 --published=publish --setdefault --file api.json

コードを参照してください: src/commands/api/create.js

`swaggerhub api:delete`

API または API バージョンを削除する

 USAGE
  $ swaggerhub api:delete OWNER/API_NAME/[VERSION] [-f] [-h]

ARGUMENTS
  OWNER/API_NAME/[VERSION]  API to delete on SwaggerHub

FLAGS
  -f, --force  delete API without prompting for confirmation
  -h, --help   Show CLI help.

DESCRIPTION
  delete an API or API version


EXAMPLES
  $ swaggerhub api:delete organization/api/1.0.0

  $ swaggerhub api:delete organization/api

  $ swaggerhub api:delete organization/api --force

コードを参照してください: src/commands/api/delete.js

`swaggerhub api:get`

API定義を取得します

 USAGE
  $ swaggerhub api:get OWNER/API_NAME/[VERSION] [-j] [-r] [-h]

ARGUMENTS
  OWNER/API_NAME/[VERSION]  API to fetch from Swaggerhub

FLAGS
  -h, --help      Show CLI help.
  -j, --json      returns the API in JSON format.
  -r, --resolved  gets the resolved API definition (supported in v1.25+).

DESCRIPTION
  fetches an API definition
  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

コードを参照してください: src/commands/api/get.js

`swaggerhub api:publish`

API バージョンを公開する

 USAGE
  $ swaggerhub api:publish OWNER/API_NAME/VERSION [-f] [-h]

ARGUMENTS
  OWNER/API_NAME/VERSION  API to publish on Swaggerhub

FLAGS
  -f, --force  publish API without prompting for confirmation
  -h, --help   Show CLI help.

DESCRIPTION
  publish an API version

EXAMPLES
  $ swaggerhub api:publish organization/api/1.0.0

  $ swaggerhub api:publish organization/api/1.0.0 --force

コードを参照してください: src/commands/api/publish.js

`swaggerhub api:setdefault`

APIのデフォルトバージョンを設定する

 USAGE
  $ swaggerhub api:setdefault OWNER/API_NAME/VERSION [-h]

ARGUMENTS
  OWNER/API_NAME/VERSION  API to set as default on Swaggerhub

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  set the default version of an API

EXAMPLES
  $ swaggerhub api:setdefault organization/api/2.0.0

コードを参照してください: src/commands/api/setdefault.js

`swaggerhub api:unpublish`

API バージョンの公開を中止する

 USAGE
  $ swaggerhub api:unpublish OWNER/API_NAME/VERSION [-h]

ARGUMENTS
  OWNER/API_NAME/VERSION  API identifier

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  unpublish an API version

EXAMPLES
  $ swaggerhub api:unpublish organization/api/1.0.0

コードを参照してください: src/commands/api/unpublish.js

`swaggerhub api:update`

APIを更新する

 USAGE
  $ swaggerhub api:update OWNER/API_NAME/[VERSION] [-f <value>] [--visibility public|private] [--published
    publish|unpublish] [--setdefault] [-h]

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

FLAGS
  -f, --file=<value>     file location of API to update
  -h, --help             Show CLI help.
  --published=<option>   sets the lifecycle setting of the API version
                         <options: publish|unpublish>
  --setdefault           sets API version to be the default
  --visibility=<option>  visibility of API in SwaggerHub
                         <options: public|private>

DESCRIPTION
  update an API
  The API version from the file will be used unless the version is specified in the command argument.
  When no file is specified then the default API version will be updated.
  The API visibility can be changed by using visibility flag.


EXAMPLES
  $ swaggerhub api:update organization/api --file api.yaml

  $ swaggerhub api:update organization/api/1.0.0 --file api.json

  $ swaggerhub api:update organization/api/1.0.0 --published=publish --file api.json

  $ swaggerhub api:update organization/api/1.0.0 --setdefault --file api.json

  $ swaggerhub api:update organization/api/1.0.0 --published=unpublish --setdefault --file api.json

  $ swaggerhub api:update organization/api/1.0.0 --visibility=private

コードを参照してください: src/commands/api/update.js

`swaggerhub api:validate`

APIバージョンの検証結果を取得する

 USAGE
  $ swaggerhub api:validate OWNER/API_NAME/[VERSION] [-c] [-j] [-h]

ARGUMENTS
  OWNER/API_NAME/[VERSION]  API to fetch validation errors for from Swaggerhub

FLAGS
  -c, --fail-on-critical  Exit with error code 1 if there are critical standardization errors present
  -h, --help              Show CLI help.
  -j, --json              Print output in JSON instead of table format

DESCRIPTION
  Get validation result for an API version
  When VERSION is not included in the argument, the default version will be validated.
  An error will occur if the API version does not exist.
  If the flag `-c` or `--failOnCritical` is used and there are standardization
  errors with `Critical` severity present, the command will exit with error code `1`.


EXAMPLES
  $ swaggerhub api:validate organization/api/1.0.0

  $ swaggerhub api:validate -c -j organization/api/1.0.0

  $ swaggerhub api:validate --fail-on-critical --json organization/api

コードを参照してください: src/commands/api/validate/index.js

`swaggerhub api:validate:download-rules`

既存の SwaggerHub の組織標準化ルールセットを取得します。

 USAGE
  $ swaggerhub api:validate:download-rules OWNER [-s] [-d] [-h]

ARGUMENTS
  OWNER  Which organization standardization rules to fetch from SwaggerHub

FLAGS
  -d, --include-disabled-rules  Includes disabled rules in fetched organization's ruleset
  -h, --help                    Show CLI help.
  -s, --include-system-rules    Includes system rules in fetched organization's ruleset

DESCRIPTION
  Get existing SwaggerHub's organization standardization ruleset.
  Requires organization name argument. An error will occur if provided organization doesn't exist
  or your account is not permitted to access that organization's settings.
  If the flag `-s` or `--include-system-rules` is used, the returned ruleset will also include SwaggerHub system rules.
  If the flag `-d` or `--include-disabled-rules` is used, the returned ruleset will also include disabled custom rules

EXAMPLES
  $ swaggerhub api:validate:download-rules myOrg -s

  $ swaggerhub api:validate:download-rules myOrg --include-disabled-rules -s

コードを参照してください: src/commands/api/validate/download-rules.js

`swaggerhub api:validate:local`

SwaggerHub 上の組織の標準化構成を使用して、ローカル API 定義に対してスキャンを実行します。

 USAGE
  $ swaggerhub api:validate:local -f <value> -o <value> [-c] [-j] [-h]

FLAGS
  -c, --fail-on-critical      Exit with error code 1 if there are critical standardization errors present
  -f, --file=<value>          (required) Path of API definition file to run scan against
  -h, --help                  Show CLI help.
  -j, --json                  Print output in JSON instead of table format
  -o, --organization=<value>  (required) Which organization's standardization settings to use for linting the target
                              definition

DESCRIPTION
  Runs a scan against a local API definition using the organization's standardization configuration on SwaggerHub.
  If the flag `-c` or `--failOnCritical` is used and there are standardization
  errors with `Critical` severity present, the command will exit with error code `1`.


EXAMPLES
  $ swaggerhub api:validate:local -o myOrg -f ./my-api.yaml -c -j 

  $ swaggerhub api:validate:local --organization myOrg --file ./my-api/json --fail-on-critical --json

コードを参照してください: src/commands/api/validate/local.js

`swaggerhub configure`

アプリケーション設定を構成する

 USAGE
  $ swaggerhub configure [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  configure application settings
  Enter the SwaggerHub URL - default is https://api.swaggerhub.com
  Customers with on-premise installations need to point this to their on-premise API, which is
  http(s)://{swaggerhub-host}/v1
  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.

コードを参照してください: src/commands/configure.js

`swaggerhub domain:create`

YAML/JSON ファイルから新しいドメイン/ドメインバージョンを作成します

 USAGE
  $ swaggerhub domain:create OWNER/DOMAIN_NAME/[VERSION] [--visibility public|private] (--published
    publish|unpublish -f <value>) [--setdefault ] [-h]

ARGUMENTS
  OWNER/DOMAIN_NAME/[VERSION]  Domain to create on SwaggerHub

FLAGS
  -f, --file=<value>     (required) file location of domain to create
  -h, --help             Show CLI help.
  --published=<option>   [default: unpublish] sets the lifecycle setting of the domain version
                         <options: publish|unpublish>
  --setdefault           sets domain version to be the default
  --visibility=<option>  [default: private] visibility of domain in SwaggerHub
                         <options: public|private>

DESCRIPTION
  creates a new domain / domain version from a YAML/JSON file
  The domain version from the file will be used unless the version is specified in the command argument.
  An error will occur if the domain version already exists.


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

  $ swaggerhub domain:create organization/domain --file domain.yaml

  $ swaggerhub domain:create organization/domain/1.0.0 --publish --file domain.json

  $ swaggerhub domain:create organization/domain/1.0.0 --setdefault --file domain.json

  $ swaggerhub domain:create organization/domain/1.0.0 --publish --setdefault --file domain.json

コードを参照してください: src/commands/domain/create.js

`swaggerhub domain:delete`

ドメインまたはドメインのバージョンを削除する

 USAGE
  $ swaggerhub domain:delete OWNER/DOMAIN_NAME/[VERSION] [-f] [-h]

ARGUMENTS
  OWNER/DOMAIN_NAME/[VERSION]  Domain to delete on SwaggerHub

FLAGS
  -f, --force  delete domain without prompting for confirmation
  -h, --help   Show CLI help.

DESCRIPTION
  delete a domain or domain version


EXAMPLES
  $ swaggerhub domain:delete organization/domain/1.0.0

  $ swaggerhub domain:delete organization/domain

  $ swaggerhub domain:delete organization/domain --force

コードを参照してください: src/commands/domain/delete.js

`swaggerhub domain:get`

ドメイン定義を取得します

 USAGE
  $ swaggerhub domain:get OWNER/DOMAIN_NAME/[VERSION] [-j] [-h]

ARGUMENTS
  OWNER/DOMAIN_NAME/[VERSION]  Domain to fetch from SwaggerHub

FLAGS
  -h, --help  Show CLI help.
  -j, --json  returns the domain in JSON format.

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


EXAMPLES
  $ swaggerhub domain:get organization/domain

  $ swaggerhub domain:get organization/domain/1.0.0 --json

コードを参照してください: src/commands/domain/get.js

`swaggerhub domain:publish`

ドメインのバージョンを公開する

 USAGE
  $ swaggerhub domain:publish OWNER/DOMAIN_NAME/VERSION [-h]

ARGUMENTS
  OWNER/DOMAIN_NAME/VERSION  Domain to publish on SwaggerHub

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  publish a domain version

EXAMPLES
  $ swaggerhub domain:publish organization/domain/1.0.0

コードを参照してください: src/commands/domain/publish.js

`swaggerhub domain:setdefault`

ドメインのデフォルトのバージョンを設定する

 USAGE
  $ swaggerhub domain:setdefault OWNER/DOMAIN_NAME/VERSION [-h]

ARGUMENTS
  OWNER/DOMAIN_NAME/VERSION  Domain to set as default on SwaggerHub

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  set the default version of a domain

EXAMPLES
  $ swaggerhub domain:setdefault organization/domain/2.0.0

コードを参照してください: src/commands/domain/setdefault.js

`swaggerhub domain:unpublish`

ドメインバージョンを非公開にする

 USAGE
  $ swaggerhub domain:unpublish OWNER/DOMAIN_NAME/VERSION [-h]

ARGUMENTS
  OWNER/DOMAIN_NAME/VERSION  Domain to unpublish on SwaggerHub

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  unpublish a domain version

EXAMPLES
  $ swaggerhub domain:unpublish organization/domain/1.0.0

コードを参照してください: src/commands/domain/unpublish.js

`swaggerhub domain:update`

ドメインを更新する

 USAGE
  $ swaggerhub domain:update OWNER/DOMAIN_NAME/[VERSION] [-f <value>] [--visibility public|private] [--published
    publish|unpublish] [--setdefault] [-h]

ARGUMENTS
  OWNER/DOMAIN_NAME/[VERSION]  Domain to update on SwaggerHub

FLAGS
  -f, --file=<value>     file location of domain to update
  -h, --help             Show CLI help.
  --published=<option>   sets the lifecycle setting of the domain version
                         <options: publish|unpublish>
  --setdefault           sets domain version to be the default
  --visibility=<option>  visibility of domain in SwaggerHub
                         <options: public|private>

DESCRIPTION
  update a domain
  The domain version from the file will be used unless the version is specified in the command argument.
  When no file is specified then the default domain version will be updated.
  The domain visibility can be changed by using visibility flag.


EXAMPLES
  $ swaggerhub domain:update organization/domain --file domain.yaml

  $ swaggerhub domain:update organization/domain/1.0.0 --file domain.json

  $ swaggerhub domain:update organization/domain/1.0.0 --published=publish --file domain.json

  $ swaggerhub domain:update organization/domain/1.0.0 --setdefault --file domain.json

  $ swaggerhub domain:update organization/domain/1.0.0 --published=unpublish --setdefault --file domain.json

  $ swaggerhub domain:update organization/domain/1.0.0 --visibility=private

コードを参照してください: src/commands/domain/update.js

`swaggerhub help`

swaggerhub のヘルプを表示します。

 USAGE
  $ swaggerhub help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for swaggerhub.

コードを参照してください: @oclif/plugin-help

`swaggerhub integration:create`

JSON 構成ファイルから新しい API 統合を作成します。

 USAGE
  $ swaggerhub integration:create OWNER/API_NAME/[VERSION] -f <value> [-h]

ARGUMENTS
  OWNER/API_NAME/[VERSION]  API to add integration to on SwaggerHub

FLAGS
  -f, --file=<value>  (required) location of integration configuration file
  -h, --help          Show CLI help.

DESCRIPTION
  creates a new API integration from a JSON configuration file.
  See the documentation for configuration files:
  https://github.com/SmartBear/swaggerhub-cli/tree/main/examples/integrations
  When VERSION is not included in the argument, the integration will be added to be default API version.


EXAMPLES
  $ swaggerhub integration:create organization/api/1.0.0 --file config.json

コードを参照してください: src/commands/integration/create.js

`swaggerhub integration:delete`

指定された API から統合を削除します。

 USAGE
  $ swaggerhub integration:delete OWNER/API_NAME/VERSION/INTEGRATION_ID [-h]

ARGUMENTS
  OWNER/API_NAME/VERSION/INTEGRATION_ID  Integration to delete for given API on Swaggerhub

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  deletes the integration from the given API.

EXAMPLES
  $ swaggerhub integration:delete organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704

コードを参照してください: src/commands/integration/delete.js

`swaggerhub integration:execute`

指定された API の統合を実行します。

 USAGE
  $ swaggerhub integration:execute OWNER/API_NAME/VERSION/INTEGRATION_ID [-h]

ARGUMENTS
  OWNER/API_NAME/VERSION/INTEGRATION_ID  Integration to execute for given API on Swaggerhub

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  executes an integration for the given API.

EXAMPLES
  $ swaggerhub integration:execute organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704

コードを参照してください: src/commands/integration/execute.js

`swaggerhub integration:get`

指定された API の統合を取得します。

 USAGE
  $ swaggerhub integration:get OWNER/API_NAME/VERSION/INTEGRATION_ID [-h]

ARGUMENTS
  OWNER/API_NAME/VERSION/INTEGRATION_ID  Integration to fetch for given API on Swaggerhub

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  retieves an integration for the given API.

EXAMPLES
  $ swaggerhub integration:get organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704

コードを参照してください: src/commands/integration/get.js

`swaggerhub integration:list`

API 上の統合をリストします。

 USAGE
  $ swaggerhub integration:list OWNER/API_NAME/[VERSION] [-h]

ARGUMENTS
  OWNER/API_NAME/[VERSION]  API to list integrations for on Swaggerhub

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  list integrations on an API.

EXAMPLES
  $ swaggerhub integration:list organization/api/1.0.0

コードを参照してください: src/commands/integration/list.js

`swaggerhub integration:update`

API 統合の構成を更新します。

 USAGE
  $ swaggerhub integration:update OWNER/API_NAME/VERSION/INTEGRATION_ID -f <value> [-h]

ARGUMENTS
  OWNER/API_NAME/VERSION/INTEGRATION_ID  Integration to update for given API on Swaggerhub

FLAGS
  -f, --file=<value>  (required) location of integration configuration file
  -h, --help          Show CLI help.

DESCRIPTION
  update the configuration of an API integration.

EXAMPLES
  $ swaggerhub integration:update organization/api/1.0.0/503c2db6-448a-4678-abcd-0123456789abc --file config.json

コードを参照してください: src/commands/integration/update.js

`swaggerhub plugins`

インストールされているプラグインを一覧表示します。

 USAGE
  $ swaggerhub plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ swaggerhub plugins

コードを参照してください: @oclif/plugin-plugins

`swaggerhub plugins:install`

CLI にプラグインをインストールします。

 USAGE
  $ swaggerhub plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ swaggerhub plugins:add

EXAMPLES
  $ swaggerhub plugins:install myplugin 

  $ swaggerhub plugins:install https://github.com/someuser/someplugin

  $ swaggerhub plugins:install someuser/someplugin

`swaggerhub plugins:inspect`

プラグインのインストールプロパティを表示します。

 USAGE
  $ swaggerhub plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ swaggerhub plugins:inspect myplugin

コードを参照してください: @oclif/plugin-plugins

`swaggerhub plugins:install`

CLI にプラグインをインストールします。

 USAGE
  $ swaggerhub plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ swaggerhub plugins:add

EXAMPLES
  $ swaggerhub plugins:install myplugin 

  $ swaggerhub plugins:install https://github.com/someuser/someplugin

  $ swaggerhub plugins:install someuser/someplugin

コードを参照してください: @oclif/plugin-plugins

`swaggerhub plugins:link`

開発のためにプラグインを CLI にリンクします。

 USAGE
  $ swaggerhub plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help      Show CLI help.
  -v, --verbose
  --[no-]install  Install dependencies after linking the plugin.

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ swaggerhub plugins:link myplugin

コードを参照してください: @oclif/plugin-plugins

`swaggerhub plugins:uninstall`

CLI からプラグインを削除します。

 USAGE
  $ swaggerhub plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ swaggerhub plugins:unlink
  $ swaggerhub plugins:remove

`swaggerhub plugins:uninstall`

CLI からプラグインを削除します。

 USAGE
  $ swaggerhub plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ swaggerhub plugins:unlink
  $ swaggerhub plugins:remove

コードを参照してください: @oclif/plugin-plugins

`swaggerhub plugins:uninstall`

CLI からプラグインを削除します。

 USAGE
  $ swaggerhub plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ swaggerhub plugins:unlink
  $ swaggerhub plugins:remove

`swaggerhub plugins:update`

インストールされているプラグインを更新します。

 USAGE
  $ swaggerhub plugins:update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

コードを参照してください: @oclif/plugin-plugins

`swaggerhub project:api:add`

既存のプロジェクトに API を追加します。

 USAGE
  $ swaggerhub project:api:add OWNER/PROJECT_NAME API [-h]

ARGUMENTS
  OWNER/PROJECT_NAME  The project to add the API to on Swaggerhub
  API                 The name of the API on Swaggerhub to add

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Adds an API to an existing project.

EXAMPLES
  $ swaggerhub project:api:add organization/project_name my_api

コードを参照してください: src/commands/project/api/add.js

`swaggerhub project:api:remove`

拡大する