Opciones de Apidog CLI

Apidog CLI se utiliza para ejecutar pruebas automatizadas y gestionar recursos de proyectos de Apidog desde un terminal o una canalización de CI/CD. Admite la ejecución de pruebas, la gestión de recursos de diseño de API, entornos y variables, importación y exportación, publicación de documentación, colaboración mediante ramas y administración de proyectos.

Sintaxis básica de Apidog CLI

La mayoría de los comandos de recursos de proyecto utilizan --project <projectId> para especificar el proyecto. Puede utilizar --branch <branchName> para operar en una rama específica. Si se omite --branch, el servidor utiliza la rama predeterminada.

Autenticación

Antes de acceder a proyectos privados, inicie sesión o proporcione un token de acceso.

Comando	Descripción	Ejemplo
`login`	Inicie sesión con un token de acceso y guárdelo localmente.	`apidog login --with-token <token>`
`logout`	Cierre sesión y borre el token local guardado.	`apidog logout`
`whoami`	Muestre información sobre el usuario autenticado actual.	`apidog whoami`

También puede pasar un token directamente al ejecutar comandos:

Si utiliza GitHub Actions, puede almacenar su token de acceso en Settings --> Secrets and Variables --> Actions --> Repository variables de su repositorio. Luego utilice ${{ vars.APIDOG_ACCESS_TOKEN }} para hacer referencia a él.

Esquema de CLI

Utilice cli-schema para inspeccionar y validar archivos JSON antes de crear o actualizar recursos complejos. Esto ayuda a reducir los errores de petición causados por datos con formato incorrecto.

Comando	Descripción	Ejemplo
`cli-schema list`	Liste todas las claves de esquema admitidas por la CLI.	`apidog cli-schema list`
`cli-schema get`	Imprima el JSON Schema para un archivo de datos de comando.	`apidog cli-schema get endpoint-create`
`cli-schema validate`	Valide un archivo JSON local con una clave de esquema.	`apidog cli-schema validate endpoint-create --file ./endpoint.json`

Las claves de esquema suelen combinar la ruta del comando y la acción, como endpoint-create, test-scenario-update y merge-request-create.

Equipos y proyectos

Los comandos de equipo y proyecto son el punto de partida para gestionar recursos mediante la CLI. Utilícelos para encontrar los ID requeridos por los comandos de nivel de proyecto.

Gestión de equipos

Comando	Descripción	Ejemplo
`team list`	Liste los equipos accesibles para la cuenta actual.	`apidog team list`
`team get`	Vea los detalles de un equipo específico.	`apidog team get <teamId>`

Gestión de proyectos

Comando	Descripción	Ejemplo
`project list`	Liste los proyectos accesibles para la cuenta actual.	`apidog project list`
`project get`	Vea los detalles del proyecto.	`apidog project get <projectId>`
`project create`	Cree un proyecto dentro de un equipo.	`apidog project create --team <teamId> --name "New Project"`

Configuración del proyecto

Comando	Descripción	Ejemplo
`project settings get`	Vea la configuración de nivel de proyecto.	`apidog project settings get --project <projectId>`
`project settings update`	Actualice la configuración del proyecto con un archivo JSON.	`apidog project settings update --project <projectId> --file ./project-settings.json`
`cli-schema get project-settings-update`	Vea el esquema para actualizaciones de configuración del proyecto.	`apidog cli-schema get project-settings-update`

Entornos y variables

Utilice estos comandos para gestionar entornos de ejecución, variables globales y variables de equipo utilizadas por la depuración de API y las pruebas automatizadas.

Gestión de entornos

Comando	Descripción	Ejemplo
`environment list`	Liste los entornos de un proyecto.	`apidog environment list --project <projectId>`
`environment get`	Vea los detalles del entorno, como las URL base.	`apidog environment get <environmentId> --project <projectId>`
`environment create`	Cree un entorno.	`apidog environment create <name> --project <projectId> --base-url <url>`
`environment update`	Actualice un entorno.	`apidog environment update <environmentId> --project <projectId> --file ./environment.json`
`environment delete`	Elimine un entorno.	`apidog environment delete <environmentId> --project <projectId>`
`cli-schema get environment-update`	Vea el esquema para actualizaciones de entorno.	`apidog cli-schema get environment-update`

Gestión de variables

Comando	Descripción	Ejemplo
`variables list`	Liste variables por ámbito.	`apidog variables list --project <projectId> --scope global`
`variables get`	Vea el valor de una variable.	`apidog variables get --project <projectId> --scope global --key <key>`
`variables set`	Cree o actualice una variable.	`apidog variables set --project <projectId> --scope global --key <key> --value <value>`
`variables delete`	Elimine una variable.	`apidog variables delete --project <projectId> --scope global --key <key>`
`variables import`	Importe variables desde un archivo local.	`apidog variables import --project <projectId> --scope global --file ./variables.json`
`variables export`	Exporte variables a un archivo local.	`apidog variables export --project <projectId> --scope global --output ./variables.json`

Recursos de diseño de API

Utilice estos comandos para gestionar recursos de diseño de API, incluidos endpoints de API HTTP, esquemas, carpetas, reglas de mock, parámetros comunes, componentes de respuesta y esquemas de seguridad. Al crear o actualizar recursos complejos, se recomienda ejecutar primero cli-schema get <schemaKey> y cli-schema validate <schemaKey> --file <path>.

Endpoints de API HTTP

Comando	Descripción	Ejemplo
`endpoint list`	Liste endpoints de API HTTP en un proyecto.	`apidog endpoint list --project <projectId>`
`endpoint get`	Vea los detalles del endpoint.	`apidog endpoint get <endpointId> --project <projectId>`
`endpoint create`	Cree un endpoint desde un archivo JSON.	`apidog endpoint create --project <projectId> --file ./endpoint.json`
`endpoint update`	Actualice un endpoint.	`apidog endpoint update <endpointId> --project <projectId> --file ./endpoint.json`
`endpoint delete`	Elimine un endpoint.	`apidog endpoint delete <endpointId> --project <projectId>`
`cli-schema get endpoint-create`	Vea el esquema para la creación de endpoints.	`apidog cli-schema get endpoint-create`
`cli-schema get endpoint-update`	Vea el esquema para actualizaciones de endpoints.	`apidog cli-schema get endpoint-update`

Esquemas de datos

Comando	Descripción	Ejemplo
`schema list`	Liste esquemas de datos en un proyecto.	`apidog schema list --project <projectId>`
`schema get`	Vea los detalles del esquema.	`apidog schema get <schemaId> --project <projectId>`
`schema create`	Cree un esquema de datos desde un archivo JSON.	`apidog schema create --project <projectId> --file ./schema.json`
`schema update`	Actualice un esquema de datos.	`apidog schema update <schemaId> --project <projectId> --file ./schema.json`
`schema delete`	Elimine un esquema de datos.	`apidog schema delete <schemaId> --project <projectId>`
`cli-schema get schema-create`	Vea el esquema para la creación de esquemas de datos.	`apidog cli-schema get schema-create`
`cli-schema get schema-update`	Vea el esquema para actualizaciones de esquemas de datos.	`apidog cli-schema get schema-update`

Documentos Markdown

Comando	Descripción	Ejemplo
`doc list`	Liste documentos Markdown.	`apidog doc list --project <projectId>`
`doc get`	Vea los detalles de un documento Markdown.	`apidog doc get <docId> --project <projectId>`
`doc create`	Cree un documento Markdown.	`apidog doc create --project <projectId> --file ./doc.json`
`doc update`	Actualice un documento Markdown.	`apidog doc update <docId> --project <projectId> --file ./doc.json`
`doc delete`	Elimine un documento Markdown.	`apidog doc delete <docId> --project <projectId>`

Carpetas de recursos

Utilice comandos folder para gestionar árboles de carpetas para diferentes tipos de recursos. La opción --type selecciona el tipo de recurso, como endpoint, schema, test-scenario, response-component, security-scheme, test-suite o test-data.

Comando	Descripción	Ejemplo
`folder list`	Liste carpetas por tipo de recurso.	`apidog folder list --project <projectId> --type endpoint`
`folder create`	Cree una carpeta por tipo de recurso.	`apidog folder create --project <projectId> --type endpoint --name "New Folder"`
`folder move`	Mueva una carpeta a otra carpeta principal.	`apidog folder move <folderId> --project <projectId> --type endpoint --parent <parentId>`
`folder update`	Actualice el nombre, la descripción o la carpeta principal.	`apidog folder update <folderId> --project <projectId> --type endpoint --name "New Folder Name"`
`folder delete`	Elimine una carpeta.	`apidog folder delete <folderId> --project <projectId> --type endpoint`
`cli-schema get folder-create`	Vea el esquema para la creación de carpetas.	`apidog cli-schema get folder-create`
`cli-schema get folder-update`	Vea el esquema para actualizaciones de carpetas.	`apidog cli-schema get folder-update`

--type selecciona el tipo de carpeta de recurso. No es el nombre de la carpeta. El campo description solo es compatible con carpetas endpoint y test-scenario; otros tipos de carpeta solo admiten actualizaciones de nombre y carpeta principal.

Reglas de mock

Comando	Descripción	Ejemplo
`mock list`	Liste reglas de mock en un proyecto o bajo un endpoint.	`apidog mock list --project <projectId> --http-api-id <endpointId>`
`mock get`	Vea una regla de mock.	`apidog mock get <mockId> --project <projectId>`
`mock create`	Cree una regla de mock desde un archivo JSON.	`apidog mock create --project <projectId> --file ./mock.json`
`mock update`	Actualice una regla de mock.	`apidog mock update <mockId> --project <projectId> --file ./mock.json`
`mock delete`	Elimine una regla de mock.	`apidog mock delete <mockId> --project <projectId>`
`cli-schema get mock-create`	Vea el esquema para la creación de reglas de mock.	`apidog cli-schema get mock-create`
`cli-schema get mock-update`	Vea el esquema para actualizaciones de reglas de mock.	`apidog cli-schema get mock-update`

Parámetros comunes

Comando	Descripción	Ejemplo
`common-parameter list`	Liste parámetros comunes reutilizables.	`apidog common-parameter list --project <projectId>`
`common-parameter get`	Vea los detalles de un parámetro común.	`apidog common-parameter get <commonParameterId> --project <projectId>`
`common-parameter create`	Cree un parámetro común desde un archivo JSON.	`apidog common-parameter create --project <projectId> --file ./common-parameter.json`
`common-parameter update`	Actualice un parámetro común.	`apidog common-parameter update <commonParameterId> --project <projectId> --file ./common-parameter.json`
`common-parameter import`	Importe parámetros comunes desde un archivo.	`apidog common-parameter import --project <projectId> --file ./common-parameters.json`
`common-parameter export`	Exporte parámetros comunes a un archivo local.	`apidog common-parameter export --project <projectId> --output ./common-parameters.json`

Componentes de respuesta

Comando	Descripción	Ejemplo
`response-component list`	Liste componentes de respuesta reutilizables.	`apidog response-component list --project <projectId>`
`response-component get`	Vea los detalles de un componente de respuesta.	`apidog response-component get <responseComponentId> --project <projectId>`
`response-component create`	Cree un componente de respuesta desde un archivo JSON.	`apidog response-component create --project <projectId> --file ./response-component.json`
`response-component update`	Actualice un componente de respuesta.	`apidog response-component update <responseComponentId> --project <projectId> --file ./response-component.json`
`response-component delete`	Elimine un componente de respuesta.	`apidog response-component delete <responseComponentId> --project <projectId>`

Esquemas de seguridad

Comando	Descripción	Ejemplo
`security-scheme list`	Liste esquemas de seguridad en un proyecto.	`apidog security-scheme list --project <projectId>`
`security-scheme get`	Vea los detalles del esquema de seguridad.	`apidog security-scheme get <schemeId> --project <projectId>`
`security-scheme create`	Cree un esquema de seguridad desde un archivo JSON.	`apidog security-scheme create --project <projectId> --file ./scheme.json`
`security-scheme update`	Actualice un esquema de seguridad.	`apidog security-scheme update <schemeId> --project <projectId> --file ./scheme.json`
`security-scheme delete`	Elimine un esquema de seguridad.	`apidog security-scheme delete <schemeId> --project <projectId>`

Las rutas de API son rutas de recursos de API, no rutas de archivos locales. Si su shell reescribe valores que comienzan con /, encierre la ruta entre comillas, por ejemplo --path '/api/users', o utilice --file para proporcionar datos del endpoint.

Para casos de prueba de API o pasos HTTP de escenarios de prueba, responseId debe utilizar un ID de definición de respuesta de endpoint de endpoint.responses[].id, no un ID de componente de respuesta. Para reutilizar un componente de respuesta, enlácelo primero en la definición de respuesta del endpoint.

Pruebas automatizadas

Utilice estos comandos para gestionar casos de prueba de API, escenarios de prueba, suites de pruebas, datos de prueba, informes de prueba, runners y tareas programadas.

Casos de prueba de API

Comando	Descripción	Ejemplo
`test-case list`	Liste casos de prueba de API, opcionalmente filtrados por endpoint.	`apidog test-case list --project <projectId> --endpoint <endpointId>`
`test-case category`	Liste categorías de casos de prueba.	`apidog test-case category --project <projectId>`
`test-case get`	Vea los detalles de un caso de prueba de API.	`apidog test-case get <caseId> --project <projectId>`
`test-case create`	Cree un caso de prueba de API desde un archivo JSON.	`apidog test-case create --project <projectId> --file ./case.json`
`test-case update`	Actualice un caso de prueba de API.	`apidog test-case update <caseId> --project <projectId> --file ./case.json`
`test-case delete`	Elimine un caso de prueba de API.	`apidog test-case delete <caseId> --project <projectId>`
`cli-schema get test-case-create`	Vea el esquema para la creación de casos de prueba.	`apidog cli-schema get test-case-create`
`cli-schema get test-case-update`	Vea el esquema para actualizaciones de casos de prueba.	`apidog cli-schema get test-case-update`

Escenarios de prueba

Comando	Descripción	Ejemplo
`test-scenario list`	Liste escenarios de prueba en un proyecto.	`apidog test-scenario list --project <projectId>`
`test-scenario get`	Vea los detalles del escenario de prueba.	`apidog test-scenario get <scenarioId> --project <projectId>`
`test-scenario create`	Cree un escenario de prueba.	`apidog test-scenario create --project <projectId> --file ./scenario.json`
`test-scenario update`	Actualice un escenario de prueba.	`apidog test-scenario update <scenarioId> --project <projectId> --file ./scenario.json`
`test-scenario delete`	Elimine un escenario de prueba.	`apidog test-scenario delete <scenarioId> --project <projectId>`
`test-scenario run`	Ejecute un escenario de prueba.	`apidog test-scenario run <scenarioId> --project <projectId> --environment <environmentId>`
`cli-schema get test-scenario-create`	Vea el esquema para la creación de escenarios de prueba.	`apidog cli-schema get test-scenario-create`
`cli-schema get test-scenario-update`	Vea el esquema para actualizaciones de escenarios de prueba.	`apidog cli-schema get test-scenario-update`

Suites de pruebas

Comando	Descripción	Ejemplo
`test-suite list`	Liste suites de pruebas en un proyecto.	`apidog test-suite list --project <projectId>`
`test-suite get`	Vea los detalles de una suite de pruebas.	`apidog test-suite get <testSuiteId> --project <projectId>`
`test-suite create`	Cree una suite de pruebas.	`apidog test-suite create --project <projectId> --file ./suite.json`
`test-suite update`	Actualice una suite de pruebas.	`apidog test-suite update <testSuiteId> --project <projectId> --file ./suite.json`
`test-suite delete`	Elimine una suite de pruebas.	`apidog test-suite delete <testSuiteId> --project <projectId>`
`test-suite run`	Ejecute una suite de pruebas.	`apidog test-suite run <testSuiteId> --project <projectId> --environment <environmentId>`

Datos de prueba

Comando	Descripción	Ejemplo
`test-data list`	Liste conjuntos de datos de prueba.	`apidog test-data list --project <projectId>`
`test-data get`	Vea los detalles de un conjunto de datos de prueba.	`apidog test-data get <dataId> --project <projectId>`
`test-data create`	Cree un conjunto de datos de prueba desde un archivo JSON.	`apidog test-data create --project <projectId> --file ./test-data.json`
`test-data update`	Actualice un conjunto de datos de prueba.	`apidog test-data update <dataId> --project <projectId> --file ./test-data.json`
`test-data delete`	Elimine un conjunto de datos de prueba.	`apidog test-data delete <dataId> --project <projectId>`

Informes de prueba

Comando	Descripción	Ejemplo
`test-report list`	Liste informes de prueba en un proyecto.	`apidog test-report list --project <projectId>`
`test-report get`	Vea los detalles del informe de prueba.	`apidog test-report get <reportId> --project <projectId>`
`test-report download`	Descargue un informe de prueba a un archivo local.	`apidog test-report download <reportId> --project <projectId> --format json --output ./report.json`
`test-report delete`	Elimine un informe de prueba.	`apidog test-report delete <reportId> --project <projectId>`

Runners

Comando	Descripción	Ejemplo
`runner list`	Liste runners en un proyecto o equipo.	`apidog runner list --project <projectId>`
`runner get`	Vea los detalles del runner.	`apidog runner get <runnerId> --project <projectId>`
`runner create`	Cree un runner de equipo.	`apidog runner create --team <teamId> --name <name> --runner-type <runnerType> --server-type <serverType>`
`runner check`	Compruebe el estado del runner.	`apidog runner check <runnerId> --team <teamId>`
`runner delete`	Elimine un runner.	`apidog runner delete <runnerId> --project <projectId>`

Tareas programadas

Comando	Descripción	Ejemplo
`scheduled-task list`	Liste tareas programadas en un proyecto.	`apidog scheduled-task list --project <projectId>`
`scheduled-task get`	Vea los detalles de una tarea programada.	`apidog scheduled-task get <taskId> --project <projectId>`
`scheduled-task create`	Cree una tarea programada desde un archivo JSON.	`apidog scheduled-task create --project <projectId> --file ./scheduled-task.json`
`scheduled-task update`	Actualice una tarea programada.	`apidog scheduled-task update <taskId> --project <projectId> --file ./scheduled-task.json`
`scheduled-task delete`	Elimine una tarea programada.	`apidog scheduled-task delete <taskId> --project <projectId>`
`scheduled-task run`	Active una tarea programada manualmente.	`apidog scheduled-task run <taskId> --project <projectId>`

Comando principal de ejecución: `apidog run`

Este es el comando principal para ejecutar escenarios de prueba, carpetas de escenarios de prueba, suites de pruebas o archivos exportados locales. Puede copiar los comandos generados desde el panel de CI/CD del cliente de Apidog y ejecutarlos en su terminal o flujo de trabajo de CI/CD.

Ejecución en línea

Al ejecutar pruebas en tiempo real mediante el servidor de Apidog, utilice el siguiente comando.

Utilice el token de acceso de Apidog junto con el ID de un escenario de prueba, directorio de escenarios de prueba o suite de pruebas específicos. Por ejemplo:

Ejecución local

Al ejecutar pruebas sin conexión mediante archivos exportados, utilice el siguiente comando.

Especifique la URL o la ruta de archivo del escenario de prueba de Apidog. Por ejemplo:

Opciones de ejecución

Opción	Descripción
`--access-token <accessToken>`	Establezca el token de autenticación para la ejecución en línea
`-t, --test-scenario <testScenarioId>`	Especifique el ID del escenario de prueba que se ejecutará
`-f, --test-scenario-folder <folderId>`	Especifique el ID del directorio de escenarios de prueba que se ejecutará
`--test-suite <testSuiteId>`	Especifique el ID de la suite de pruebas que se ejecutará
`--project <projectId>`	Especifique el ID del proyecto
`--branch <branchName>`	Especifique el nombre de la rama; si se omite, el servidor usa la rama principal de forma predeterminada
`-r, --reporters [reporters]`	Especifique los tipos de informe de prueba (predeterminado: `["cli"]`)
`--out-dir <outDir>`	Directorio de salida para informes de prueba (predeterminado: `./apidog-reports`)
`--out-file <outFile>`	Nombre del archivo de informe de prueba sin necesidad de añadir una extensión de archivo. Puede utilizar `{FOLDER_NAME}`, `{SCENARIO_NAME}` y `{GENERATE_TIME}`
`--out-json-failures-separated <outJsonFailuresSeparated>`	Exporte los fallos como archivo JSON separado
`-e, --environment <environmentId>`	Especifique el entorno de ejecución
`-n, --iteration-count <n>`	Establezca el número de iteraciones
`-d, --iteration-data <path>`	Establezca los datos para iteraciones de casos (JSON o CSV)
`--on-error <behavior>`	Establezca el comportamiento de gestión de errores (`ignore`, `continue` o `end`)
`--variables <path>`	Cargue variables de entorno o globales desde un archivo local
`--global-var <value>`	Establezca variables globales (formato `key=value`)
`--env-var <value>`	Establezca variables de entorno (formato `key=value`)
`--notification <ids>`	Envíe notificaciones después de que finalice la ejecución
`--notification-failed-event <ids>`	Envíe notificaciones solo cuando falle la ejecución
`--external-program-path <path>`	Especifique la ruta de archivo para programas externos
`--database-connection <path>`	Especifique la ruta de archivo para la configuración de base de datos
`--ignore-redirects`	Evite redirecciones automáticas
`--silent`	Evite la salida por consola
`--color <value>`	Habilite o deshabilite la salida de consola con colores
`--delay-request [n]`	Especifique el retraso entre peticiones (ms)
`--timeout-request [n]`	Especifique el tiempo de espera de la petición (ms)
`--timeout-script [n]`	Especifique el tiempo de espera de ejecución de script (ms)
`-k, --insecure`	Deshabilite la verificación SSL
`--ssl-client-cert-list <path>`	Especifique la ruta de configuración de certificados de cliente
`--ssl-client-cert <path>`	Especifique la ruta del certificado de cliente (PEM)
`--ssl-client-key <path>`	Especifique la ruta de la clave privada del certificado de cliente
`--ssl-client-passphrase <passphrase>`	Especifique la frase de contraseña del certificado de cliente
`--ssl-extra-ca-certs <path>`	Especifique certificados CA de confianza adicionales
`-b, --bigint`	Habilite la compatibilidad con bigint
`--upload-report [value]`	Suba el resumen del informe de prueba a la nube
`--preferred-http-version <preferredHttpVersion>`	Establezca la versión preferida del protocolo HTTP
`--verbose`	Muestre información detallada de petición y respuesta
`--lang <language>`	Establezca el idioma de la CLI (en)
`-h, --help`	Muestre información de ayuda

Al crear o actualizar recursos de prueba complejos, como escenarios de prueba, suites de pruebas, casos de prueba, datos de prueba o tareas programadas, utilice primero cli-schema get <schemaKey> y luego valide su archivo local con cli-schema validate <schemaKey> --file <path>.

Importación y exportación

Utilice los comandos de importación y exportación para incorporar documentos de API externos a Apidog o exportar datos de proyecto a formatos utilizados por otras herramientas.

Importar datos de proyecto

El comando import importa un archivo local a un proyecto. Los formatos admitidos incluyen openapi, postman, har, insomnia, jmeter, wsdl, yapi, rap2, apidoc, hoppscotch, markdown, jsonschema y apidog.

Comando	Descripción	Ejemplo
`import`	Importe un archivo local a un proyecto por formato.	`apidog import --project <projectId> --format openapi --file ./openapi.json`

Configuración de importación automática

Utilice import auto-import para mantener la configuración de importación automática para la sincronización a largo plazo desde fuentes externas.

Comando	Descripción	Ejemplo
`import auto-import list`	Liste configuraciones de importación automática en un proyecto.	`apidog import auto-import list --project <projectId>`
`import auto-import create`	Cree una configuración de importación automática.	`apidog import auto-import create --project <projectId> --file ./auto-import.json`
`import auto-import get`	Vea una configuración de importación automática.	`apidog import auto-import get <settingId> --project <projectId>`
`import auto-import delete`	Elimine una configuración de importación automática.	`apidog import auto-import delete <settingId> --project <projectId>`
`cli-schema get import-auto-import-create`	Vea el esquema para configuraciones de importación automática.	`apidog cli-schema get import-auto-import-create`

Exportar datos de proyecto

El comando export exporta datos de proyecto a un archivo local. Los formatos admitidos incluyen openapi, markdown, html, postman y apidog.

Para la exportación nativa de apidog, el ámbito admite all, apis y tags. El ámbito de carpeta solo está disponible para la exportación OpenAPI.

Comando	Descripción	Ejemplo
`export`	Exporte datos de proyecto por formato.	`apidog export --project <projectId> --format openapi --output ./openapi.json`
`export --format apidog`	Exporte datos nativos del proyecto.	`apidog export --project <projectId> --format apidog --output ./project.apidog.json`
`export --scope apis`	Exporte API seleccionadas en formato nativo.	`apidog export --project <projectId> --format apidog --scope apis --api-ids 1001,1002 --output ./selected.apidog.json`
`export --scope tags`	Exporte API por etiquetas en formato nativo.	`apidog export --project <projectId> --format apidog --scope tags --include-tags pet,store --output ./tagged.apidog.json`
`export --format openapi --scope folders`	Exporte carpetas seleccionadas en formato OpenAPI.	`apidog export --project <projectId> --format openapi --scope folders --folder-ids 2001 --output ./openapi.json`

Configuración de exportación OAS

Utilice export settings para mantener configuraciones de exportación OAS reutilizables.

Comando	Descripción	Ejemplo
`export settings list`	Liste configuraciones de exportación OAS.	`apidog export settings list --project <projectId>`
`export settings create`	Cree una configuración de exportación OAS.	`apidog export settings create --project <projectId> --file ./export-setting.json`
`export settings get`	Vea una configuración de exportación OAS.	`apidog export settings get <settingId> --project <projectId>`
`export settings update`	Actualice una configuración de exportación OAS.	`apidog export settings update <settingId> --project <projectId> --file ./export-setting.json`
`export settings delete`	Elimine una configuración de exportación OAS.	`apidog export settings delete <settingId> --project <projectId>`
`cli-schema get export-settings-create`	Vea el esquema para la creación de configuraciones de exportación OAS.	`apidog cli-schema get export-settings-create`
`cli-schema get export-settings-update`	Vea el esquema para actualizaciones de configuraciones de exportación OAS.	`apidog cli-schema get export-settings-update`

Uso compartido de documentación

Utilice estos comandos para publicar y compartir documentación de API.

Sitios de documentación

Comando	Descripción	Ejemplo
`docs-site list`	Liste sitios de documentación.	`apidog docs-site list --project <projectId>`
`docs-site get`	Vea los detalles del sitio de documentación.	`apidog docs-site get <siteId> --project <projectId>`
`docs-site create`	Cree un sitio de documentación.	`apidog docs-site create --project <projectId> --file ./docs-site.json`
`docs-site update`	Actualice la configuración del sitio de documentación.	`apidog docs-site update <siteId> --project <projectId> --file ./docs-site.json`
`docs-site delete`	Elimine un sitio de documentación.	`apidog docs-site delete <siteId> --project <projectId>`

Documentos compartidos

Comando	Descripción	Ejemplo
`shared-doc list`	Liste documentos compartidos.	`apidog shared-doc list --project <projectId>`
`shared-doc get`	Vea los detalles del documento compartido.	`apidog shared-doc get <docId> --project <projectId>`
`shared-doc create`	Cree un documento compartido.	`apidog shared-doc create --project <projectId> --file ./shared-doc.json`
`shared-doc update`	Actualice la configuración del documento compartido.	`apidog shared-doc update <docId> --project <projectId> --file ./shared-doc.json`
`shared-doc delete`	Elimine un documento compartido.	`apidog shared-doc delete <docId> --project <projectId>`

Gestión de ramas

Utilice comandos de rama para aislar cambios, colaborar en recursos de proyecto y fusionar recursos seleccionados entre ramas.

Ramas de iteración

Comando	Descripción	Ejemplo
`branch list --type all`	Liste todos los tipos de rama en un proyecto.	`apidog branch list --project <projectId> --type all`
`branch list --type sprint`	Liste ramas de iteración.	`apidog branch list --project <projectId> --type sprint`
`branch get --type sprint`	Vea una rama de iteración.	`apidog branch get <branchName> --project <projectId> --type sprint`
`branch create --type sprint`	Cree una rama de iteración.	`apidog branch create --project <projectId> --type sprint --name <branchName> --from main`
`branch update --type sprint`	Actualice una rama de iteración.	`apidog branch update <branchName> --project <projectId> --type sprint --name <newName>`
`branch merge`	Fusione recursos seleccionados explícitamente de una rama a otra.	`apidog branch merge --project <projectId> --from <sourceBranchName> --to <targetBranchName> --endpoint-ids <ids>`
`branch pick-to`	Seleccione recursos de una rama de origen para una rama de destino.	`apidog branch pick-to --project <projectId> --from <sourceBranchName> --to <targetBranchName> --endpoint-ids <ids>`
`branch archive --type sprint`	Archive una rama de iteración antes de eliminarla.	`apidog branch archive <branchName> --project <projectId> --type sprint`
`branch delete --type sprint`	Elimine una rama de iteración archivada.	`apidog branch delete <branchName> --project <projectId> --type sprint`

Ramas de IA

Comando	Descripción	Ejemplo
`branch list --type ai`	Liste ramas de IA.	`apidog branch list --project <projectId> --type ai`
`branch get --type ai`	Vea una rama de IA.	`apidog branch get <branchName> --project <projectId> --type ai`
`branch create --type ai`	Cree una rama de IA desde una rama de origen.	`apidog branch create --project <projectId> --type ai --name <aiBranchName> --from <sourceBranchName>`
`branch update --type ai`	Actualice una rama de IA.	`apidog branch update <branchName> --project <projectId> --type ai --name <newName>`
`branch archive --type ai`	Archive una rama de IA antes de eliminarla.	`apidog branch archive <branchName> --project <projectId> --type ai`
`branch delete --type ai`	Elimine una rama de IA archivada.	`apidog branch delete <branchName> --project <projectId> --type ai`

Ramas generales

Comando	Descripción	Ejemplo
`branch list --type general`	Liste ramas generales.	`apidog branch list --project <projectId> --type general`
`branch get --type general`	Vea una rama general.	`apidog branch get <branchName> --project <projectId> --type general`
`branch create --type general`	Cree una rama general.	`apidog branch create --project <projectId> --type general --name <branchName> --from main`
`branch update --type general`	Actualice una rama general.	`apidog branch update <branchName> --project <projectId> --type general --name <newName>`
`branch delete --type general`	Elimine una rama general.	`apidog branch delete <branchName> --project <projectId> --type general`

Los comandos de creación de ramas utilizan principalmente opciones de línea de comandos como --type, --name y --from. cli-schema get branch-*-create se utiliza para inspeccionar la estructura de opciones de creación. Para las opciones reales del comando, ejecute apidog branch create -h.

Solicitudes de fusión

Utilice merge-request cuando la rama de destino requiera un flujo de revisión. Las solicitudes de fusión y las fusiones directas solo fusionan recursos seleccionados explícitamente.

Comando	Descripción	Ejemplo
`merge-request preview`	Escanee cambios candidatos antes de crear una solicitud de fusión o una fusión directa.	`apidog merge-request preview --project <projectId> --from <sourceBranchName> --to <targetBranchName>`
`merge-request list`	Liste solicitudes de fusión.	`apidog merge-request list --project <projectId> --to <targetBranchName>`
`merge-request get`	Vea los detalles de la solicitud de fusión.	`apidog merge-request get <mergeRequestId> --project <projectId> --to <targetBranchName>`
`merge-request create`	Cree una solicitud de fusión.	`apidog merge-request create --project <projectId> --to <targetBranchName> --from <sourceBranchName> --reviewer-ids <userIds> --endpoint-ids <ids>`
`merge-request update`	Actualice una solicitud de fusión.	`apidog merge-request update <mergeRequestId> --project <projectId> --to <targetBranchName> --file ./merge-request.json`
`merge-request approve`	Apruebe una solicitud de fusión.	`apidog merge-request approve <mergeRequestId> --project <projectId> --to <targetBranchName> --file ./approve.json`
`merge-request reject`	Rechace una solicitud de fusión.	`apidog merge-request reject <mergeRequestId> --project <projectId> --to <targetBranchName>`
`merge-request delete`	Elimine una solicitud de fusión.	`apidog merge-request delete <mergeRequestId> --project <projectId> --to <targetBranchName>`

Para mantener seguros los recursos del proyecto, los permisos de escritura de la CLI pueden estar restringidos de forma predeterminada. Puede editar datos de la rama de origen mediante una rama de IA, o habilitar permisos de edición externa en la configuración de funciones del proyecto cuando se requiera edición directa para la rama principal, ramas de iteración estándar o ramas generales. Los cambios realizados en una rama de IA siguen necesitando confirmación del usuario antes de merge o merge-request.

Se recomienda que los nombres de ramas de IA incluyan la fecha, la rama de origen y el propósito, por ejemplo ai/20260312-from-main-user-register.

Para operaciones de fusión y selección de ramas, las opciones de ID de recursos utilizan nombres en plural e ID numéricos separados por comas, como --endpoint-ids 1,2, --doc-ids 3,4 y --test-suite-ids 5,6.

Otros recursos

Utilice estos comandos para gestionar recursos de extensión de proyecto y conexiones externas.

Campos personalizados

Comando	Descripción	Ejemplo
`custom-field list`	Liste campos personalizados.	`apidog custom-field list --project <projectId>`
`custom-field create`	Cree un campo personalizado.	`apidog custom-field create --project <projectId> --file ./custom-field.json`
`custom-field update`	Actualice un campo personalizado.	`apidog custom-field update <customFieldId> --project <projectId> --file ./custom-field.json`
`custom-field delete`	Elimine un campo personalizado.	`apidog custom-field delete <customFieldId> --project <projectId>`

API WebSocket

Comando	Descripción	Ejemplo
`websocket list`	Liste API WebSocket.	`apidog websocket list --project <projectId>`
`websocket get`	Vea los detalles de la API WebSocket.	`apidog websocket get <websocketId> --project <projectId>`
`websocket create`	Cree una API WebSocket.	`apidog websocket create --project <projectId> --name <name> --url <url>`
`websocket update`	Actualice una API WebSocket.	`apidog websocket update <websocketId> --project <projectId> --file ./websocket.json`
`websocket delete`	Elimine una API WebSocket.	`apidog websocket delete <websocketId> --project <projectId>`

API Socket.IO

Comando	Descripción	Ejemplo
`socketio list`	Liste API Socket.IO.	`apidog socketio list --project <projectId>`
`socketio get`	Vea los detalles de la API Socket.IO.	`apidog socketio get <socketioId> --project <projectId>`
`socketio create`	Cree una API Socket.IO.	`apidog socketio create --project <projectId> --file ./socketio.json`
`socketio update`	Actualice una API Socket.IO.	`apidog socketio update <socketioId> --project <projectId> --file ./socketio.json`
`socketio delete`	Elimine una API Socket.IO.	`apidog socketio delete <socketioId> --project <projectId>`

Scripts comunes

Comando	Descripción	Ejemplo
`common-script list`	Liste scripts comunes.	`apidog common-script list --project <projectId>`
`common-script get`	Vea los detalles de un script común.	`apidog common-script get <scriptId> --project <projectId>`
`common-script create`	Cree un script común.	`apidog common-script create --project <projectId> --file ./common-script.json`
`common-script update`	Actualice un script común.	`apidog common-script update <scriptId> --project <projectId> --file ./common-script.json`
`common-script delete`	Elimine un script común.	`apidog common-script delete <scriptId> --project <projectId>`

Conexiones de base de datos

Comando	Descripción	Ejemplo
`database-connection list`	Liste conexiones de base de datos.	`apidog database-connection list --project <projectId>`
`database-connection get`	Vea los detalles de la conexión de base de datos.	`apidog database-connection get <connectionId> --project <projectId>`
`database-connection create`	Cree una conexión de base de datos.	`apidog database-connection create --project <projectId> --file ./database-connection.json`
`database-connection update`	Actualice una conexión de base de datos.	`apidog database-connection update <connectionId> --project <projectId> --file ./database-connection.json`
`database-connection delete`	Elimine una conexión de base de datos.	`apidog database-connection delete <connectionId> --project <projectId>`

Proveedores de bóveda

Comando	Descripción	Ejemplo
`vault list`	Liste proveedores de bóveda.	`apidog vault list --project <projectId>`
`vault get`	Vea los detalles del proveedor de bóveda.	`apidog vault get <vaultProviderId> --project <projectId>`
`vault create`	Cree un proveedor de bóveda.	`apidog vault create --project <projectId> --file ./vault.json`
`vault update`	Actualice un proveedor de bóveda.	`apidog vault update <vaultProviderId> --project <projectId> --file ./vault.json`
`vault delete`	Elimine un proveedor de bóveda.	`apidog vault delete <vaultProviderId> --project <projectId>`

Conexiones Git

Comando	Descripción	Ejemplo
`git-connection list`	Liste conexiones Git.	`apidog git-connection list --project <projectId>`
`git-connection get`	Vea los detalles de la conexión Git.	`apidog git-connection get <connectionId> --project <projectId>`
`git-connection create`	Cree una conexión Git.	`apidog git-connection create --project <projectId> --file ./git-connection.json`
`git-connection update`	Actualice una conexión Git.	`apidog git-connection update <connectionId> --project <projectId> --file ./git-connection.json`
`git-connection delete`	Elimine una conexión Git.	`apidog git-connection delete <connectionId> --project <projectId>`

Gestión y configuración

Utilice estos comandos para la administración de proyectos, notificaciones, recursos de papelera de reciclaje, historial de cambios y registros de auditoría.

Notificaciones

Comando	Descripción	Ejemplo
`notification list`	Liste configuraciones de notificación.	`apidog notification list --project <projectId>`
`notification get`	Vea los detalles de la notificación.	`apidog notification get <notificationId> --project <projectId>`
`notification create`	Cree una configuración de notificación.	`apidog notification create --project <projectId> --file ./notification.json`
`notification update`	Actualice una configuración de notificación.	`apidog notification update <notificationId> --project <projectId> --file ./notification.json`
`notification delete`	Elimine una configuración de notificación.	`apidog notification delete <notificationId> --project <projectId>`

Papelera de reciclaje

Comando	Descripción	Ejemplo
`recycle list`	Liste recursos en la papelera de reciclaje.	`apidog recycle list --project <projectId>`
`recycle restore`	Restaure un recurso desde la papelera de reciclaje.	`apidog recycle restore <itemId> --project <projectId>`
`recycle delete`	Elimine permanentemente un recurso de la papelera de reciclaje.	`apidog recycle delete <itemId> --project <projectId>`

Historial

Comando	Descripción	Ejemplo
`history list`	Liste el historial de cambios del proyecto.	`apidog history list --project <projectId>`
`history get`	Vea los detalles del historial de cambios.	`apidog history get <historyId> --project <projectId>`

Registros de auditoría

Comando	Descripción	Ejemplo
`audit-log list`	Liste registros de auditoría del proyecto.	`apidog audit-log list --project <projectId>`
`audit-log get`	Vea los detalles del registro de auditoría.	`apidog audit-log get <auditLogId> --project <projectId>`

Uso avanzado

Carga de archivos en la CLI

Al trabajar con API que requieren cargas de archivos, establecer con precisión la ruta del archivo que se cargará es crucial. Debe almacenar el archivo en la misma máquina donde se ejecutan las pruebas y hacer referencia a él mediante su ruta absoluta o relativa. Siga estos pasos para hacer referencia a un archivo que se cargará.

Copie previamente el archivo requerido en la máquina que ejecuta la CLI. Por ejemplo, si utiliza GitHub Actions como su canalización de CI/CD, copie el archivo requerido en el mismo repositorio de GitHub que el de su flujo de trabajo.

En Apidog, vaya a su escenario de prueba y localice el paso que requiere carga de archivos. Haga clic en el botón Bulk Edit, como se muestra a continuación.

Botón de edición por lotes en los detalles del paso del escenario de prueba

Copie la ruta del archivo que copió en la máquina de la CLI. Luego reemplace el valor del parámetro del campo de archivo con la ruta del archivo en la máquina de la CLI. Por ejemplo, si coloca un archivo png en la carpeta data de un repositorio de GitHub, puede utilizar data/to-be-uploaded.png para hacer referencia a él.

Configuración de ruta de archivo en modo de edición por lotes

Después de esta configuración, el archivo puede enviarse correctamente a Apidog mediante la CLI.

Si desea volver a ejecutar este escenario de prueba localmente, deberá modificar la ruta del archivo en el valor del parámetro para que vuelva a ser la ruta en su máquina local.

Uso de operaciones de base de datos en la CLI

Cuando sus escenarios de prueba incluyen operaciones de base de datos, debe realizar algunos pasos adicionales porque las configuraciones de base de datos se guardan localmente, no en la nube. Esto significa que no puede ejecutar directamente la CLI en modo nube para estos escenarios. A continuación se explica cómo manejar esta situación:

Para escenarios de prueba que incluyen operaciones de base de datos, verá un aviso en la interfaz de generación de línea de comandos: "Download the database configuration file."

Descargue este archivo y colóquelo en el directorio donde planea ejecutar Apidog CLI.

La línea de comandos generada automáticamente incluirá la opción --database-connection. Puede utilizar esta línea de comandos tal como está para ejecutar sus pruebas.

Carga de informes de prueba locales de la CLI a la nube

Para cargar sus informes de prueba locales de la CLI a la nube, puede añadir el parámetro --upload-report al final de su comando de CLI. A continuación se explica cómo hacerlo:

Añada el parámetro --upload-report a su comando de CLI:

Este comando ejecutará sus pruebas y cargará automáticamente el informe de prueba a la nube tras completarse.

Para ver el informe cargado:

Vaya a la sección "Test Reports" en su panel de Apidog.

Busque la columna "Team Reports".

Nota: Para los informes cargados mediante la CLI, el campo "Tester" se mostrará vacío.

Uso de scripts/programas externos en la CLI

Puede hacer referencia a scripts o programas externos al ejecutar Apidog CLI añadiendo su ruta al final del comando. A continuación se explica cómo hacerlo:

En este ejemplo, se indica a la CLI que haga referencia a programas ubicados en el directorio ./scripts. Si no se especifica ninguna jerarquía, el valor predeterminado es el directorio actual de ejecución de la CLI.

Existen dos enfoques principales para gestionar estos scripts externos:

1. Ruta local

Para evitar confusiones en la gestión de scripts locales, se recomienda:

Organizar todos los archivos de script por categoría

Colocarlos en un directorio específico

Especificar la ruta local correspondiente en el comando de CLI

2. Repositorio de código en la nube

Como alternativa, puede:

Alojar archivos de script en un repositorio de código basado en la nube

Configurar comandos de extracción en su flujo de trabajo de CI/CD para obtener scripts externos en el entorno local

Especificar la ruta real de los scripts externos en el comando de CLI

SSL

Certificado de cliente

Apidog CLI admite pasar certificados de cliente.

Uso de un único certificado de cliente SSL

--ssl-client-cert
Especifique la ruta del certificado público de cliente SSL.

--ssl-client-key
Especifique la ruta del certificado privado de cliente SSL (opcional).

--ssl-client-passphrase
Especifique la frase de contraseña del cliente SSL (opcional).

Uso de un archivo de configuración de certificados de cliente SSL (admite varios certificados)

--ssl-client-cert-list
Especifique la ruta del archivo JSON de la lista de certificados de cliente SSL. Por ejemplo: ssl-client-cert-list.json

[
    {
        "name": "domain1",
        "matches": ["https://test.domain1.com/*", "https://www.domain1/*"],
        "key": {"src": "/CI/client.domain1.key"},
        "cert": {"src": "/CI/client.domain1.crt"},
        "passphrase": "changeme"
    },
    {
        "name": "domain2",
        "matches": ["https://domain2.com/*"],
        "key": {"src": "/CI/client.domain2.key"},
        "cert": {"src": "/CI/client.domain2.crt"},
        "passphrase": "changeme"
    }
]

Esta opción admite establecer diferentes certificados de cliente SSL según la URL o el nombre de host. Tiene prioridad sobre las opciones --ssl-client-cert, --ssl-client-key y --ssl-client-passphrase. Estas opciones se utilizarán como opciones de reserva si no hay coincidencia para la URL en la lista.

HTTP/2

La CLI puede configurarse para utilizar versiones de protocolo específicas al enviar peticiones mediante el parámetro --preferred-http-version.

Valores del parámetro de versión de protocolo:

"HTTP/2" - Negociación de protocolo de capa de aplicación HTTP/2 (ALPN), compatible solo con peticiones HTTPS.

"HTTP/2-with-prior-knowledge" - HTTP/2 con conocimiento previo.

"HTTP/1" - HTTP/1.1.

El parámetro admite las siguientes configuraciones:

Establecer diferentes versiones de protocolo para peticiones HTTPS y HTTP:

Establecer la misma versión de protocolo para HTTPS y HTTP:

Establecer HTTP/2 para HTTPS y HTTP (los valores no compatibles se ignorarán automáticamente):

Preguntas frecuentes

¿Cómo gestionar el mensaje de error Invalid character in header content['Authorization']?

Este error suele deberse a caracteres no válidos en el encabezado Authorization, como caracteres no ASCII, saltos de línea o espacios adicionales. Si tiene la certeza de que ejecutar escenarios de prueba en el cliente de Apidog o en la interfaz web no produce errores, compruebe si ha establecido valores INITIAL para variables en su entorno y confirme que el valor Authorization coincida con el formato esperado.

¿Cómo puedo editar datos del proyecto directamente sin usar una rama de IA?

Los permisos de escritura del proyecto pueden estar restringidos por seguridad. Compruebe la configuración de funciones del proyecto y habilite los permisos de edición externa cuando se requiera edición directa.

Opciones de Apidog CLI

Sintaxis básica de Apidog CLI#

Autenticación#

Esquema de CLI#

Equipos y proyectos#

Gestión de equipos#

Gestión de proyectos#

Configuración del proyecto#

Entornos y variables#

Gestión de entornos#

Gestión de variables#

Recursos de diseño de API#

Endpoints de API HTTP#

Esquemas de datos#

Documentos Markdown#

Carpetas de recursos#

Reglas de mock#

Parámetros comunes#

Componentes de respuesta#

Esquemas de seguridad#

Pruebas automatizadas#

Casos de prueba de API#

Escenarios de prueba#

Suites de pruebas#

Datos de prueba#

Informes de prueba#

Runners#

Tareas programadas#

Comando principal de ejecución: apidog run#

Ejecución en línea#

Ejecución local#

Opciones de ejecución#

Importación y exportación#

Importar datos de proyecto#

Configuración de importación automática#

Exportar datos de proyecto#

Configuración de exportación OAS#

Uso compartido de documentación#

Sitios de documentación#

Documentos compartidos#

Gestión de ramas#

Ramas de iteración#

Ramas de IA#

Ramas generales#

Solicitudes de fusión#

Otros recursos#

Campos personalizados#

API WebSocket#

API Socket.IO#

Scripts comunes#

Conexiones de base de datos#

Proveedores de bóveda#

Conexiones Git#

Gestión y configuración#

Notificaciones#

Papelera de reciclaje#

Historial#

Registros de auditoría#

Uso avanzado#

Carga de archivos en la CLI#

Uso de operaciones de base de datos en la CLI#

Carga de informes de prueba locales de la CLI a la nube#

Uso de scripts/programas externos en la CLI#

1. Ruta local#

2. Repositorio de código en la nube#

SSL#

Certificado de cliente#

Uso de un único certificado de cliente SSL#

Uso de un archivo de configuración de certificados de cliente SSL (admite varios certificados)#

HTTP/2#

Preguntas frecuentes#

Sintaxis básica de Apidog CLI

Autenticación

Esquema de CLI

Equipos y proyectos

Gestión de equipos

Gestión de proyectos

Configuración del proyecto

Entornos y variables

Gestión de entornos

Gestión de variables

Recursos de diseño de API

Endpoints de API HTTP

Esquemas de datos

Documentos Markdown

Carpetas de recursos

Reglas de mock

Parámetros comunes

Componentes de respuesta

Esquemas de seguridad

Pruebas automatizadas

Casos de prueba de API

Escenarios de prueba

Suites de pruebas

Datos de prueba

Informes de prueba

Runners

Tareas programadas

Comando principal de ejecución: `apidog run`

Ejecución en línea

Ejecución local

Opciones de ejecución

Importación y exportación

Importar datos de proyecto

Configuración de importación automática

Exportar datos de proyecto

Configuración de exportación OAS

Uso compartido de documentación

Sitios de documentación

Documentos compartidos

Gestión de ramas

Ramas de iteración

Ramas de IA

Ramas generales

Solicitudes de fusión

Otros recursos

Campos personalizados

API WebSocket

API Socket.IO

Scripts comunes

Conexiones de base de datos

Proveedores de bóveda

Conexiones Git

Gestión y configuración

Notificaciones

Papelera de reciclaje

Historial

Registros de auditoría

Uso avanzado

Carga de archivos en la CLI

Uso de operaciones de base de datos en la CLI

Carga de informes de prueba locales de la CLI a la nube

Uso de scripts/programas externos en la CLI

1. Ruta local

2. Repositorio de código en la nube

SSL

Certificado de cliente

Uso de un único certificado de cliente SSL

Uso de un archivo de configuración de certificados de cliente SSL (admite varios certificados)

HTTP/2

Preguntas frecuentes