หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>ซอร์สโค้ดอื่น ๆ
ดาวน์โหลด

SwaggerHub 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 (จำเป็น) - สำคัญ: รักษาคีย์นี้ให้ปลอดภัย นี่คือคีย์ SwaggerHub API ที่ CLI จะใช้สำหรับการตรวจสอบสิทธิ์ คุณสามารถค้นหาคีย์ 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 On-Premise

หากอินสแตนซ์ SwaggerHub On-Premise ของคุณใช้ ใบรับรอง SSL ที่ลงนามด้วยตนเองหรือลงนามแบบส่วนตัว มีขั้นตอนเพิ่มเติมที่จำเป็นในการทำให้ SwaggerHub CLI เชื่อถือใบรับรองนี้

ตามค่าเริ่มต้น Node.js จะปฏิเสธใบรับรอง SSL ที่ลงนามด้วยตนเองหรือที่ลงนามแบบส่วนตัว เนื่องจากไม่รู้จัก CA หลัก คุณจะเห็นข้อผิดพลาดเช่นนี้ในเอาต์พุต 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-----

ระบุเส้นทางไปยังไฟล์ 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

ตัวอย่างวินโดวส์: 

 :: 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

สร้างเวอร์ชัน API / API ใหม่จากไฟล์ YAML/JSON 

 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

ดำเนินการสแกนกับข้อกำหนด API ภายในเครื่องโดยใช้การกำหนดค่ามาตรฐานขององค์กรบน SwaggerHub 

 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

สร้างการรวม API ใหม่จากไฟล์การกำหนดค่า JSON 

 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

ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด