Colaboración en equipo

Colaboración multiusuario y sincronización en tiempo real

La capacidad de colaboración en tiempo real de la documentación de API ayuda a mejorar la eficiencia del trabajo de los equipos de I+D y reduce el coste de la comunicación repetida. Los módulos de API HTTP y modelo de datos en la gestión de API admiten la colaboración multiusuario en línea en tiempo real. Cuando otras personas guardan datos, la página actual actualizará automáticamente los cambios realizados por otros miembros del equipo.

Escenarios aplicables

En los siguientes escenarios, la nueva documentación de API se sincronizará automáticamente con los miembros del equipo sin necesidad de una actualización global manual:

Modificar y guardar una API dentro de la aplicación

Después de importar periódicamente archivos Swagger/OpenAPI

Aspectos destacados

Las funciones de colaboración multiusuario de Apidog incluyen:

Visualización en tiempo real de los avatares de los editores, mostrando claramente quién está editando la misma API

Colaboración a nivel de campo, lo que evita eficazmente conflictos de contenido

Si hay un conflicto, usted lo sabrá durante la edición para poder resolverlo con antelación y continuar editando

Resolución de conflictos detallada, que permite conservar contenido parcial de ambas partes

La documentación de API tiene historial de versiones y papelera de reciclaje, admite la reversión a versiones antiguas, por lo que no necesita preocuparse por modificaciones accidentales

La importación automática y el plugin de IDEA también forman parte de la colaboración en tiempo real; los datos se actualizan automáticamente después de la importación

Enlaces de colaboración

La función "Enlace de colaboración" permite a los miembros del equipo localizar rápidamente APIs y colaborar.

INFO

Los enlaces de colaboración solo se utilizan para compartir dentro del equipo, y las personas que no sean miembros del equipo no pueden abrir el enlace de colaboración.

Copiar el enlace de colaboración

Toque el botón Copiar enlace de colaboración en la barra de menú del lado derecho de la API para crear un enlace de colaboración. Envíelo a otros miembros del equipo, abra el enlace y podrá localizar directamente la API correspondiente en el terminal web.

Especificación de la URL del enlace

Los enlaces de Apidog se componen de varios componentes clave:

ID del proyecto

Ejemplo: https://apidog.com/web/project/{Project-ID}

Endpoint especificado dentro del proyecto

Ejemplo: https://apidog.com/web/project/{Project-ID}/apis/api-{API-ID}

Pestaña especificada dentro de un endpoint

Ejemplo: https://apidog.com/web/project/{Project-ID}/apis/api-{API-ID}-run

Esta estructura de URL permite a los usuarios acceder a proyectos, APIs y vistas específicos dentro de la plataforma Apidog.

Insertar valores de parámetros en URLs

Al compartir endpoints de Apidog, el comportamiento predeterminado es incluir únicamente la especificación de la API sin ningún valor de parámetro. Sin embargo, si necesita compartir el documento con valores específicos de parámetros o variables incluidos, puede insertarlos directamente en la URL del documento.

Pasar valores de parámetros

Existen dos enfoques para insertar valores de parámetros en la URL: el modo simple y el modo complejo. El modo simple es más directo y no requiere codificación de URL, pero no admite caracteres de corchetes. El modo complejo admite todos los caracteres, pero requiere codificar los datos de parámetros.

Modo simple

En el modo simple, puede usar el formato query[xxx]=yyy para asignar el valor yyy al parámetro llamado xxx.

Ejemplo:

https://apidog.com/web/project/406014/apis/api-10061199-run?query[aaa]=yyy&query[bbb]=yyy&path[aaa]=yyy&body[aaa]=yyy&header[aaa]=yyy&cookie[aaa]=yyy&environment[aaa]=yyy

Tipo de parámetro	Valor del parámetro	Descripción
Parámetros de query	`query[xxx]=yyy`
Parámetros de path	`path[xxx]=yyy`
Parámetros de body	`body[xxx]=yyy`	Para tipos de cuerpo form-data o x-www-urlencoded
Parámetros de body	`body=yyy`	Para otros tipos de cuerpo
Parámetros de header	`header[xxx]=yyy`
Parámetros de cookie	`cookie[xxx]=yyy`
Variables de entorno	`environment[xxx]=yyy`	Se guardarán en las variables de entorno predeterminadas

Modo complejo

El modo complejo permite una inserción de parámetros más avanzada mediante la codificación de un objeto JSON. El valor del parámetro params se obtiene llamando a encodeURIComponent sobre los siguientes datos JSON:

{
    "query": [
        ["id", "value1"], 
        ["id", "value2"], 
        ["key2", "value3"]
    ],
    "path": [
        ["key1", "value1"], 
        ["key2", "value2"]
    ],
    "body": [
        ["aaa", "value1"], 
        ["key2", "value2"]
    ],
    "header": [
        ["testHeader", "value1"], 
        ["key2", "value2"]
    ], 
    "cookie": [
        ["testCookie", "value1"], 
        ["key2", "value2"]
    ], 
    "environment": [
        ["key1", "value1"], 
        ["key2", "value2"]
    ]
}

La URL codificada tendría este aspecto:

https://apidog.com/web/project/406014/apis/api-10061199-run?params={ "query"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" }%2C "body"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" }%2C "cookie"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" }%2C "environment"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" } }

Tipo de parámetros	Valor de parámetros	Descripción
Parámetros de query	`query`
Parámetros de path	`path`
Parámetros de body	`body`	Si el tipo de cuerpo es form-data o x-www-urlencoded, el valor de body es JSON; de lo contrario, el valor de body es una cadena
Parámetros de header	`header`
Parámetros de cookie	`cookie`
Variables de entorno	`environment`	Se guardarán en las variables de entorno predeterminadas

Pasar variables de entorno

También puede usar la URL para establecer automáticamente las "variables de entorno" del usuario pasando parámetros. Para hacerlo, añada parámetros de URL con el formato environment[variable name]=variable value.

Por ejemplo:

https://apidog.com/web/project/406014?environment[aaa]=xxx&environment[bbb]=yyy

https://apidog.com/web/project/406014/apis/api-10061199-run?environment[aaa]=xxx

Cambiar el método de apertura

Los enlaces de colaboración admiten la apertura tanto en el cliente como en el lado web. Si desea localizar la API a través del cliente, vaya a Apidog Web, toque Settings ⚙ y active la opción Always open collaboration links on desktop en General.

INFO

Esta opción solo está disponible en Apidog Web, pero no en Apidog Client.

El cliente se invocará automáticamente cuando se acceda al enlace de colaboración.

Colaboración en equipo

Colaboración multiusuario y sincronización en tiempo real#

Escenarios aplicables#

Aspectos destacados#

Enlaces de colaboración#

Copiar el enlace de colaboración#

Especificación de la URL del enlace#

Insertar valores de parámetros en URLs#

Pasar valores de parámetros#

Modo simple#

Modo complejo#

Pasar variables de entorno#

Cambiar el método de apertura#

Colaboración multiusuario y sincronización en tiempo real

Escenarios aplicables

Aspectos destacados

Enlaces de colaboración

Copiar el enlace de colaboración

Especificación de la URL del enlace

Insertar valores de parámetros en URLs

Pasar valores de parámetros

Modo simple

Modo complejo

Pasar variables de entorno

Cambiar el método de apertura