Colaboração em Equipe

Colaboração Multiusuário e Sincronização em Tempo Real

O recurso de colaboração em tempo real da documentação de API ajuda a melhorar a eficiência do trabalho para equipes de P&D e reduz o custo da comunicação repetida. Os módulos de API HTTP e modelo de dados no gerenciamento de APIs oferecem suporte à colaboração online multiusuário em tempo real. Quando outras pessoas salvam dados, a página atual atualizará automaticamente as alterações feitas por outros membros da equipe.

Cenários Aplicáveis

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

Modificar e salvar uma API no App

Após importar periodicamente arquivos Swagger/OpenAPI

Destaques

Os recursos de colaboração multiusuário do Apidog incluem:

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

Colaboração em nível de campo, evitando efetivamente conflitos de conteúdo

Se houver um conflito, você saberá durante a edição para poder resolvê-lo antecipadamente e continuar editando

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 lixeira, oferecendo suporte à 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

Links de Colaboração

O recurso "Link de Colaboração" permite que membros da equipe localizem APIs rapidamente e colaborem.

INFO

Links de colaboração são usados apenas para compartilhamento dentro da equipe, e pessoas que não são membros da equipe não conseguem abrir o link de colaboração.

Copiar o Link de Colaboração

Toque no botão Copiar Link de Colaboração na barra de menu no lado direito da API para criar um link de colaboração. Envie-o para outros membros da equipe, abra o link e você poderá localizar diretamente a API correspondente no terminal web.

Especificação da URL do Link

Os links do Apidog são compostos por vários componentes principais:

ID do Projeto

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

Endpoint Especificado dentro do Projeto

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

Aba Especificada dentro de um Endpoint

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

Essa estrutura de URL permite que os usuários acessem projetos, APIs e visualizações específicas dentro da plataforma Apidog.

Incorporar Valores de Parâmetros em URLs

Ao compartilhar endpoints do Apidog, o comportamento padrão é incluir apenas a especificação da API, sem valores de parâmetros. No entanto, se você precisar compartilhar o documento com valores específicos de parâmetros ou variáveis incluídos, poderá incorporá-los diretamente na URL do documento.

Passar Valores de Parâmetros

Há duas abordagens para incorporar valores de parâmetros na URL: o modo simples e o modo complexo. O modo simples é mais direto e não exige codificação de URL, mas não oferece suporte a caracteres de colchetes. O modo complexo oferece suporte a todos os caracteres, mas exige a codificação dos dados dos parâmetros.

Modo Simples

No modo simples, você pode usar 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`	Elas serão salvas nas variáveis de ambiente padrão

Modo Complexo

O modo complexo permite uma incorporação de parâmetros mais avançada ao codificar um objeto JSON. O valor do parâmetro params é obtido chamando 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"]
    ]
}

A URL codificada seria semelhante a:

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 será JSON; caso contrário, o valor de body será uma string
Parâmetros de Cabeçalho	`header`
Parâmetros de Cookie	`cookie`
Variáveis de Ambiente	`environment`	Elas serão salvas nas variáveis de ambiente padrão

Passar Variáveis de Ambiente

Você também pode usar a URL para definir automaticamente as "variáveis de ambiente" do usuário passando parâmetros. Para fazer isso, adicione parâmetros de URL no formato environment[variable name]=variable value.

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

Links de colaboração oferecem suporte à abertura tanto no cliente quanto no lado web. Se você quiser localizar a API por meio do cliente, acesse o Apidog Web, toque em Configurações ⚙ e ative a opção Sempre abrir links de colaboração no desktop em Geral.

INFO

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

O cliente será acionado automaticamente quando o link de colaboração for acessado.

Colaboração em Equipe

Colaboração Multiusuário e Sincronização em Tempo Real#

Cenários Aplicáveis#

Destaques#

Links de Colaboração#

Copiar o Link de Colaboração#

Especificação da URL do Link#

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 Multiusuário e Sincronização em Tempo Real

Cenários Aplicáveis

Destaques

Links de Colaboração

Copiar o Link de Colaboração

Especificação da URL do Link

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