홈페이지>프로그래밍 관련>기타 소스코드
다운로드

스웨거허브 CLI

SwaggerHub CLI를 사용하면 팀이 SwaggerHub를 중심으로 자동화 및 워크플로를 구축할 수 있습니다. 팀은 CI/CD 파이프라인과 같은 곳에서 이를 사용하여 새 API를 생성하고, API 버전을 생성 및 업데이트하고, 다른 기능 중에서 API 버전을 게시 및 기본값으로 표시할 수 있습니다. 모든 팀에는 고유한 워크플로가 있으며 SwaggerHub CLI는 팀이 필요에 맞는 워크플로를 구축하는 데 도움을 줄 수 있습니다.

  • 요구사항
  • 설치
  • 설정
  • SwaggerHub On-Premise에 대한 추가 구성
  • 용법
  • 명령
  • 플러그인
  • 기여

요구사항

Node.js 18.x 이상.

설치 

$ npm i -g swaggerhub-cli

설정

SwaggerHub CLI는 환경 변수 또는 swaggerhub configure 명령을 통해 구성할 수 있습니다. CLI는 다음 환경 변수를 찾습니다.

  • SWAGGERHUB_API_KEY (필수) – 중요: 이 키를 안전하게 유지하세요. 이는 CLI가 인증에 사용할 SwaggerHub API 키입니다. SwaggerHub의 사용자 설정 페이지에서 API 키를 찾을 수 있습니다.
  • 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 On-Premise에 대한 추가 구성

SwaggerHub 온프레미스 인스턴스가 자체 서명 또는 비공개로 서명된 SSL 인증서를 사용하는 경우 SwaggerHub CLI가 이 인증서를 신뢰하도록 하려면 추가 단계가 필요합니다.

기본적으로 Node.js는 루트 CA가 알려져 있지 않기 때문에 자체 서명되거나 개인적으로 서명된 SSL 인증서를 거부합니다. CLI 출력에 다음과 같은 오류가 표시됩니다. 

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

해결책은 NODE_EXTRA_CA_CERTS 환경 변수를 사용하여 Node.js에 대해 신뢰할 수 있는 사용자 정의 인증서를 지정하는 것입니다.

PEM 형식의 신뢰할 수 있는 사용자 정의 인증서가 포함된 .pem 파일을 생성하는 것부터 시작하세요.

  • 인증서가 자체 서명된 경우(자체 CA인 경우) 인증서 자체를 포함합니다.
  • 인증서가 사설 CA에서 서명 된 경우 CA 루트와 중간 인증서를 순서에 관계없이 포함합니다. 개별 인증서 사이에는 빈 줄이 허용되지만 선택 사항입니다. 
 -----BEGIN CERTIFICATE-----
CA root certificate
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
Intermediate certificate 1
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
Intermediate certificate 2
-----END CERTIFICATE-----

NODE_EXTRA_CA_CERTS 환경 변수에 이 PEM 파일의 경로를 지정합니다.

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

확장하다
추가 정보
관련 애플리케이션
추천
관련 정보 전체