Startseite>Programmierbezogen>Anderer Quellcode
Herunterladen

SwaggerHub-CLI

Mit der SwaggerHub-CLI können Teams Automatisierung und Arbeitsabläufe rund um SwaggerHub aufbauen. Teams können es unter anderem an Orten wie ihrer CI/CD-Pipeline verwenden, um neue APIs zu erstellen, API-Versionen zu erstellen und zu aktualisieren und API-Versionen als veröffentlicht und als Standard zu markieren. Jedes Team hat seinen eigenen Workflow und die SwaggerHub-CLI kann Teams dabei helfen, den Workflow zu erstellen, der ihren Anforderungen entspricht.

  • Anforderungen
  • Installation
  • Aufstellen
  • Zusätzliche Konfiguration für SwaggerHub On-Premise
  • Verwendung
  • Befehle
  • Plugins
  • Mitwirken

Anforderungen

Node.js 18.x oder höher.

Installation 

$ npm i -g swaggerhub-cli

Aufstellen

Die SwaggerHub-CLI kann über Umgebungsvariablen oder über den Befehl swaggerhub configure konfiguriert werden. Die CLI sucht nach den folgenden Umgebungsvariablen.

  • SWAGGERHUB_API_KEY (erforderlich) – Wichtig: Bewahren Sie diesen Schlüssel sicher auf. Dies ist der SwaggerHub-API-Schlüssel, den die CLI zur Authentifizierung verwendet. Sie finden Ihren API-Schlüssel auf der Seite mit den Benutzereinstellungen in SwaggerHub.
  • SWAGGERHUB_URL (optional, Standard ist https://api.swaggerhub.com ) – Kunden mit On-Premise-Installationen müssen dies auf ihre On-Premise-API verweisen, die http(s)://{swaggerhub-host}/v1 ist (keinen Backslash anhängen).

Alternativ können Sie den Befehl swaggerhub configure verwenden, um eine Konfigurationsdatei für die Verwendung durch die CLI zu erstellen. Dieser Befehl führt Sie durch die Schritte zum Einrichten der erforderlichen Konfigurationen. 

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

Umgebungsvariablen haben Vorrang vor der mit diesem Befehl erstellten Konfigurationsdatei.

Zusätzliche Konfiguration für SwaggerHub On-Premise

Wenn Ihre SwaggerHub On-Premise-Instanz ein selbstsigniertes oder privat signiertes SSL-Zertifikat verwendet, sind zusätzliche Schritte erforderlich, damit die SwaggerHub-CLI diesem Zertifikat vertraut.

Standardmäßig lehnt Node.js selbstsignierte oder privat signierte SSL-Zertifikate ab, da ihre Stammzertifizierungsstelle nicht bekannt ist. In der CLI-Ausgabe wird ein Fehler wie dieser angezeigt: 

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

Die Lösung besteht darin, die Umgebungsvariable NODE_EXTRA_CA_CERTS zu verwenden, um benutzerdefinierte vertrauenswürdige Zertifikate für Node.js anzugeben.

Erstellen Sie zunächst eine PEM-Datei mit Ihren benutzerdefinierten vertrauenswürdigen Zertifikaten im PEM-Format.

  • Wenn das Zertifikat selbstsigniert ist (also eine eigene Zertifizierungsstelle ist), schließen Sie das Zertifikat selbst ein.
  • Wenn das Zertifikat von einer privaten Zertifizierungsstelle signiert ist, geben Sie das CA-Stammzertifikat und alle Zwischenzertifikate in beliebiger Reihenfolge an. Zwischen einzelnen Zertifikaten sind Leerzeilen zulässig, jedoch optional. 
 -----BEGIN CERTIFICATE-----
CA root certificate
-----END CERTIFICATE-----

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

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

Geben Sie den Pfad zu dieser PEM-Datei in der Umgebungsvariablen NODE_EXTRA_CA_CERTS an.

macOS/*nix/bash-Beispiele: 

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

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

Verwendung 

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

Befehle

  • 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

erstellt eine neue API/API-Version aus einer YAML/JSON-Datei 

 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

Siehe Code: src/commands/api/create.js

swaggerhub api:delete

Löschen Sie eine API oder API-Version 

 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

Siehe Code: src/commands/api/delete.js

swaggerhub api:get

ruft eine API-Definition ab 

 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

Siehe Code: src/commands/api/get.js

swaggerhub api:publish

eine API-Version veröffentlichen 

 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

Siehe Code: src/commands/api/publish.js

swaggerhub api:setdefault

Legen Sie die Standardversion einer API fest 

 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

Siehe Code: src/commands/api/setdefault.js

swaggerhub api:unpublish

Veröffentlichung einer API-Version rückgängig machen 

 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

Siehe Code: src/commands/api/unpublish.js

swaggerhub api:update

eine API aktualisieren 

 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

Siehe Code: src/commands/api/update.js

swaggerhub api:validate

Validierungsergebnis für eine API-Version abrufen 

 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

Siehe Code: src/commands/api/validate/index.js

swaggerhub api:validate:download-rules

Holen Sie sich den bestehenden Organisationsstandardisierungsregelsatz von 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

Siehe Code: src/commands/api/validate/download-rules.js

swaggerhub api:validate:local

Führt einen Scan anhand einer lokalen API-Definition unter Verwendung der Standardisierungskonfiguration der Organisation auf SwaggerHub durch. 

 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

Siehe Code: src/commands/api/validate/local.js

swaggerhub configure

Anwendungseinstellungen konfigurieren 

 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.

Siehe Code: src/commands/configure.js

swaggerhub domain:create

Erstellt eine neue Domäne/Domänenversion aus einer YAML/JSON-Datei 

 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

Siehe Code: src/commands/domain/create.js

swaggerhub domain:delete

Löschen Sie eine Domäne oder Domänenversion 

 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

Siehe Code: src/commands/domain/delete.js

swaggerhub domain:get

ruft eine Domänendefinition ab 

 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

Siehe Code: src/commands/domain/get.js

swaggerhub domain:publish

eine Domänenversion veröffentlichen 

 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

Siehe Code: src/commands/domain/publish.js

swaggerhub domain:setdefault

Legen Sie die Standardversion einer Domäne fest 

 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

Siehe Code: src/commands/domain/setdefault.js

swaggerhub domain:unpublish

Veröffentlichung einer Domänenversion rückgängig machen 

 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

Siehe Code: src/commands/domain/unpublish.js

swaggerhub domain:update

eine Domain aktualisieren 

 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

Siehe Code: src/commands/domain/update.js

swaggerhub help

Hilfe für Swaggerhub anzeigen. 

 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.

Siehe Code: @oclif/plugin-help

swaggerhub integration:create

Erstellt eine neue API-Integration aus einer JSON-Konfigurationsdatei. 

 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

Siehe Code: src/commands/integration/create.js

swaggerhub integration:delete

löscht die Integration aus der angegebenen 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

Siehe Code: src/commands/integration/delete.js

swaggerhub integration:execute

führt eine Integration für die angegebene API aus. 

 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

Siehe Code: src/commands/integration/execute.js

swaggerhub integration:get

Ruft eine Integration für die angegebene API ab. 

 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

Siehe Code: src/commands/integration/get.js

swaggerhub integration:list

Listen Sie Integrationen auf einer API auf. 

 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

Siehe Code: src/commands/integration/list.js

swaggerhub integration:update

Aktualisieren Sie die Konfiguration einer API-Integration. 

 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

Siehe Code: src/commands/integration/update.js

swaggerhub plugins

Installierte Plugins auflisten. 

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

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ swaggerhub plugins

Siehe Code: @oclif/plugin-plugins

swaggerhub plugins:install

Installiert ein Plugin in der 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

Zeigt Installationseigenschaften eines Plugins an. 

 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

Siehe Code: @oclif/plugin-plugins

swaggerhub plugins:install

Installiert ein Plugin in der 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

Siehe Code: @oclif/plugin-plugins

swaggerhub plugins:link

Verknüpft ein Plugin zur Entwicklung mit der 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

Siehe Code: @oclif/plugin-plugins

swaggerhub plugins:uninstall

Entfernt ein Plugin aus der 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

Entfernt ein Plugin aus der 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

Siehe Code: @oclif/plugin-plugins

swaggerhub plugins:uninstall

Entfernt ein Plugin aus der 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

Installierte Plugins aktualisieren. 

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

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

DESCRIPTION
  Update installed plugins.

Siehe Code: @oclif/plugin-plugins

swaggerhub project:api:add

Fügt einem vorhandenen Projekt eine API hinzu. 

 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

Siehe Code: src/commands/project/api/add.js

swaggerhub project:api:remove

Expandieren
Zusätzliche Informationen
Ähnliche Anwendungen
Empfohlen für Sie
Ähnliche Nachrichten Alle