Inicio>Relacionado con la programación>Otro código fuente
Descargar

CLI de Swagger Hub

La CLI de SwaggerHub permite a los equipos crear automatización y flujos de trabajo en torno a SwaggerHub. Los equipos pueden usarlo en lugares como su canal de CI/CD para crear nuevas API, crear y actualizar versiones de API y marcar versiones de API como publicadas y predeterminadas, entre otras características. Cada equipo tiene su propio flujo de trabajo y SwaggerHub CLI puede ayudar a los equipos a crear el flujo de trabajo que se adapte a sus necesidades.

  • Requisitos
  • Instalación
  • Configuración
  • Configuración adicional para SwaggerHub On-Premise
  • Uso
  • Comandos
  • Complementos
  • Contribuyendo

Requisitos

Node.js 18.x o posterior.

Instalación 

$ npm i -g swaggerhub-cli

Configuración

La CLI de SwaggerHub se puede configurar a través de variables de entorno o mediante el comando swaggerhub configure . La CLI buscará las siguientes variables de entorno.

  • SWAGGERHUB_API_KEY (obligatorio): importante: mantenga esta clave en un lugar seguro. Esta es la clave API de SwaggerHub que la CLI utilizará para la autenticación. Puede encontrar su clave API en la página de configuración de usuario en SwaggerHub.
  • SWAGGERHUB_URL (opcional, el valor predeterminado es https://api.swaggerhub.com ): los clientes con instalaciones locales deben apuntar esto a su API local, que es http(s)://{swaggerhub-host}/v1 (no agregue una barra invertida).

Como alternativa, puede utilizar el comando swaggerhub configure para crear un archivo de configuración para que lo utilice la CLI. Este comando lo guiará a través de los pasos para establecer las configuraciones necesarias. 

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

Las variables de entorno tienen prioridad sobre el archivo de configuración creado por este comando.

Configuración adicional para SwaggerHub On-Premise

Si su instancia SwaggerHub On-Premise utiliza un certificado SSL autofirmado o firmado de forma privada , se requieren pasos adicionales para que la CLI de SwaggerHub confíe en este certificado.

De forma predeterminada, Node.js rechaza los certificados SSL autofirmados o firmados de forma privada porque se desconoce su CA raíz. Verá un error como este en la salida CLI: 

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

La solución es utilizar la variable de entorno NODE_EXTRA_CA_CERTS para especificar certificados confiables personalizados para Node.js.

Comience creando un archivo .pem que contenga sus certificados de confianza personalizados en formato PEM.

  • Si el certificado está autofirmado (de modo que es su propia CA), incluya el certificado en sí.
  • Si el certificado está firmado por una CA privada , incluya la raíz de la CA y cualquier certificado intermedio, en cualquier orden. Se permiten líneas en blanco, pero son opcionales, entre certificados individuales. 
 -----BEGIN CERTIFICATE-----
CA root certificate
-----END CERTIFICATE-----

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

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

Especifique la ruta a este archivo PEM en la variable de entorno NODE_EXTRA_CA_CERTS .

Ejemplos de 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

Ejemplos de 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

Uso 

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

Comandos

  • 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

crea una nueva versión API/API a partir de un archivo 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

Ver código: src/commands/api/create.js

swaggerhub api:delete

eliminar una API o una versión de 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

Ver código: src/commands/api/delete.js

swaggerhub api:get

busca una definición de 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

Ver código: src/commands/api/get.js

swaggerhub api:publish

publicar una versión de 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

Ver código: src/commands/api/publish.js

swaggerhub api:setdefault

establecer la versión predeterminada de una 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

Ver código: src/commands/api/setdefault.js

swaggerhub api:unpublish

anular la publicación de una versión de 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

Ver código: src/commands/api/unpublish.js

swaggerhub api:update

actualizar una 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

Ver código: src/commands/api/update.js

swaggerhub api:validate

Obtener el resultado de la validación para una versión de 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

Ver código: src/commands/api/validate/index.js

swaggerhub api:validate:download-rules

Obtenga el conjunto de reglas de estandarización de organizaciones existentes de 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

Ver código: src/commands/api/validate/download-rules.js

swaggerhub api:validate:local

Ejecuta un escaneo contra una definición de API local utilizando la configuración de estandarización de la organización en 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

Ver código: src/commands/api/validate/local.js

swaggerhub configure

configurar los ajustes de la aplicación 

 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.

Ver código: src/commands/configure.js

swaggerhub domain:create

crea un nuevo dominio/versión de dominio a partir de un archivo 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

Ver código: src/commands/domain/create.js

swaggerhub domain:delete

eliminar un dominio o versión de dominio 

 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

Ver código: src/commands/domain/delete.js

swaggerhub domain:get

busca una definición de dominio 

 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

Ver código: src/commands/domain/get.js

swaggerhub domain:publish

publicar una versión de dominio 

 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

Ver código: src/commands/domain/publish.js

swaggerhub domain:setdefault

establecer la versión predeterminada de un dominio 

 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

Ver código: src/commands/domain/setdefault.js

swaggerhub domain:unpublish

anular la publicación de una versión de dominio 

 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

Ver código: src/commands/domain/unpublish.js

swaggerhub domain:update

actualizar un dominio 

 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

Ver código: src/commands/domain/update.js

swaggerhub help

Mostrar ayuda para 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.

Ver código: @oclif/plugin-help

swaggerhub integration:create

crea una nueva integración API a partir de un archivo de configuración 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

Ver código: src/commands/integration/create.js

swaggerhub integration:delete

elimina la integración de la API dada. 

 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

Ver código: src/commands/integration/delete.js

swaggerhub integration:execute

ejecuta una integración para la API dada. 

 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

Ver código: src/commands/integration/execute.js

swaggerhub integration:get

recupera una integración para la API dada. 

 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

Ver código: src/commands/integration/get.js

swaggerhub integration:list

enumerar integraciones en una 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

Ver código: src/commands/integration/list.js

swaggerhub integration:update

actualizar la configuración de una integración 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

Ver código: src/commands/integration/update.js

swaggerhub plugins

Lista de complementos instalados. 

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

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ swaggerhub plugins

Ver código: @oclif/plugin-plugins

swaggerhub plugins:install

Instala un complemento en la 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

Muestra las propiedades de instalación de un complemento. 

 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

Ver código: @oclif/plugin-plugins

swaggerhub plugins:install

Instala un complemento en la 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

Ver código: @oclif/plugin-plugins

swaggerhub plugins:link

Vincula un complemento a la CLI para su desarrollo. 

 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

Ver código: @oclif/plugin-plugins

swaggerhub plugins:uninstall

Elimina un complemento de la 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

Elimina un complemento de la 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

Ver código: @oclif/plugin-plugins

swaggerhub plugins:uninstall

Elimina un complemento de la 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

Actualizar complementos instalados. 

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

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

DESCRIPTION
  Update installed plugins.

Ver código: @oclif/plugin-plugins

swaggerhub project:api:add

Agrega una API a un proyecto existente. 

 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

Ver código: src/commands/project/api/add.js

swaggerhub project:api:remove

Expandir
Información adicional
Aplicaciones relacionadas
Recomendado para ti
Información relacionada Todo