Colaboração em Equipa

Colaboração Multiutilizador e Sincronização em Tempo Real

A capacidade de colaboração em tempo real da documentação de API ajuda a melhorar a eficiência do trabalho das equipas de I&D e reduz o custo da comunicação repetida. Os módulos de API HTTP e de modelo de dados na gestão de API suportam colaboração online multiutilizador em tempo real. Quando outras pessoas guardam dados, a página atual atualizará automaticamente as alterações efetuadas por outros membros da equipa.

Cenários Aplicáveis

Nos seguintes cenários, a nova documentação de API será automaticamente sincronizada com os membros da equipa, sem necessidade de atualização global manual:

Modificar e guardar uma API na aplicação

Após a importação periódica de ficheiros Swagger/OpenAPI

Destaques

As funcionalidades de colaboração multiutilizador do Apidog incluem:

Apresentação em tempo real dos avatares dos editores, mostrando claramente quem está a editar a mesma API

Colaboração ao nível do campo, evitando eficazmente conflitos de conteúdo

Se existir um conflito, você saberá durante a edição, para que possa resolvê-lo antecipadamente e continuar a editar

Resolução de conflitos granular, permitindo preservar conteúdo parcial de ambos os lados

A documentação de API tem histórico de versões e reciclagem, suportando a reversão para versões antigas, sem necessidade de se preocupar com modificações acidentais

A importação automática e o plugin IDEA também fazem parte da colaboração em tempo real; os dados são atualizados automaticamente após a importação

Ligações de Colaboração

A funcionalidade "Ligação de Colaboração" permite aos membros da equipa localizar rapidamente APIs e colaborar.

INFO

As ligações de colaboração são utilizadas apenas para partilha dentro da equipa, e membros que não pertençam à equipa não conseguem abrir a ligação de colaboração.

Copiar a Ligação de Colaboração

Clique no botão Copiar Ligação de Colaboração na barra de menu do lado direito da API para criar uma ligação de colaboração. Envie-a a outros membros da equipa, abra a ligação, e poderá localizar diretamente a API correspondente no terminal web.

Especificação do URL da Ligação

As ligações do Apidog são compostas por vários componentes principais:

ID do Projeto

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

Endpoint Especificado no Projeto

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

Separador Especificado num Endpoint

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

Esta estrutura de URL permite aos utilizadores aceder a projetos, APIs e vistas específicos na plataforma Apidog.

Incorporar Valores de Parâmetros em URLs

Ao partilhar endpoints do Apidog, o comportamento predefinido é incluir apenas a especificação da API, sem quaisquer valores de parâmetros. No entanto, se precisar de partilhar o documento com valores de parâmetros ou variáveis específicos incluídos, pode incorporá-los diretamente no URL do documento.

Passar Valores de Parâmetros

Existem duas abordagens para incorporar valores de parâmetros no URL: o modo simples e o modo complexo. O modo simples é mais direto e não requer codificação de URL, mas não suporta caracteres de parênteses retos. O modo complexo suporta todos os caracteres, mas requer a codificação dos dados dos parâmetros.

Modo Simples

No modo simples, pode utilizar o formato query[xxx]=yyy para atribuir o valor yyy ao parâmetro chamado xxx.

Exemplo:

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 do Parâmetro	Descrição
Parâmetros de Query	`query[xxx]=yyy`
Parâmetros de Path	`path[xxx]=yyy`
Parâmetros de Corpo	`body[xxx]=yyy`	Para tipos de corpo form-data ou x-www-urlencoded
Parâmetros de Corpo	`body=yyy`	Para outros tipos de corpo
Parâmetros de Cabeçalho	`header[xxx]=yyy`
Parâmetros de Cookie	`cookie[xxx]=yyy`
Variáveis de Ambiente	`environment[xxx]=yyy`	Estas serão guardadas nas variáveis de ambiente predefinidas

Modo Complexo

O modo complexo permite uma incorporação de parâmetros mais avançada através da codificação de um objeto JSON. O valor do parâmetro params é obtido ao chamar encodeURIComponent nos seguintes dados 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"]
    ]
}

O URL codificado teria o seguinte aspeto:

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 dos Parâmetros	Descrição
Parâmetros de Query	`query`
Parâmetros de Path	`path`
Parâmetros de Corpo	`body`	Se o tipo de corpo for form-data ou x-www-urlencoded, o valor de body é JSON; caso contrário, o valor de body é uma string
Parâmetros de Cabeçalho	`header`
Parâmetros de Cookie	`cookie`
Variáveis de Ambiente	`environment`	Estas serão guardadas nas variáveis de ambiente predefinidas

Passar Variáveis de Ambiente

Também pode utilizar o URL para definir automaticamente as "variáveis de ambiente" do utilizador através da passagem de parâmetros. Para tal, adicione parâmetros de URL no formato environment[nome da variável]=valor da variável.

Por exemplo:

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

Alterar o Método de Abertura

As ligações de colaboração suportam abertura tanto no cliente como na interface web. Se quiser localizar a API através do cliente, aceda ao Apidog Web, clique em Settings ⚙ e ative a opção Always open collaboration links on desktop em General.

INFO

Esta opção está disponível apenas no Apidog Web, não no Apidog Client.

O cliente será automaticamente invocado quando a ligação de colaboração for acedida.

Colaboração em Equipa

Colaboração Multiutilizador e Sincronização em Tempo Real#

Cenários Aplicáveis#

Destaques#

Ligações de Colaboração#

Copiar a Ligação de Colaboração#

Especificação do URL da Ligação#

Incorporar Valores de Parâmetros em URLs#

Passar Valores de Parâmetros#

Modo Simples#

Modo Complexo#

Passar Variáveis de Ambiente#

Alterar o Método de Abertura#

Colaboração Multiutilizador e Sincronização em Tempo Real

Cenários Aplicáveis

Destaques

Ligações de Colaboração

Copiar a Ligação de Colaboração

Especificação do URL da Ligação

Incorporar Valores de Parâmetros em URLs

Passar Valores de Parâmetros

Modo Simples

Modo Complexo

Passar Variáveis de Ambiente

Alterar o Método de Abertura