Partilha Rápida

A colaboração eficaz em APIs exige uma partilha de documentação fluida. A Partilha Rápida elimina a ineficiência de enviar ficheiros Word ou PDF, disponibilizando ligações instantâneas para documentação online. Esta funcionalidade permite uma comunicação rápida entre equipas, permitindo-lhe partilhar endpoints de API específicos com colaboradores, mantendo o controlo sobre o acesso, a visibilidade e a expiração.

Pré-requisitos

Antes de criar uma Partilha Rápida, certifique-se de que tem:

Uma conta Apidog com acesso a um projeto

Endpoints de API ou documentação para partilhar

(Opcional) Ambientes configurados, se pretender que os leitores testem endpoints

Criar uma Partilha Rápida

Mude para o módulo Publicar documentação na barra lateral esquerda.

Clique em +New para criar uma nova Partilha Rápida. Um projeto suporta várias Partilhas Rápidas, que podem ser distribuídas a diferentes colaboradores. Todos os membros da equipa podem visualizar Partilhas Rápidas criadas por qualquer pessoa da equipa.

Opções de configuração

Na caixa de diálogo Nova Partilha, pode personalizar as seguintes opções:

Título: O nome desta partilha, visível apenas dentro da equipa Apidog, utilizado para identificação interna e não visível na documentação partilhada.

Ambientes: Escolha os ambientes disponíveis no documento online. Por predefinição, não está selecionado nenhum ambiente. Pode selecionar vários ambientes. Os ambientes selecionados ficarão visíveis para os leitores na documentação e podem ser utilizados para enviar pedidos ao usar "Try it out".

Ambiente de Cloud Mock

Se selecionar o ambiente de Cloud mock ao criar a documentação, estará a fornecer aos leitores um ambiente sandbox simples para testar APIs sem afetar os sistemas de produção.

Conteúdo do documento: O documento tem dois componentes opcionais: URL base e exemplos de pedidos. Pode escolher se pretende apresentá-los no documento.

URL base: Este é o URL base definido no ambiente. Se selecionado, cada interface no documento mostrará o URL completo; se não for selecionado, o URL no documento começará por "/".

Proprietários: Mostrar os proprietários desta documentação de API.

Exemplos de pedidos: Se deve apresentar código de exemplo para chamar pedidos. Consulte exemplos de pedidos para obter detalhes.

Mostrar a hora da "Última modificação" acima da descrição do endpoint.

Mostrar a hora da "Última modificação" no final da documentação.

Permitir "Exportar", "Clonar" dados: Se deve permitir que os leitores exportem e clonem dados em formato OAS/Markdown/HTML/Apidog.

Âmbito a partilhar: Escolha quais endpoints de API e Markdown incluir nesta partilha. Pode selecionar por diretório ou filtro e excluir por etiqueta. Também pode optar por partilhar a pasta inteira.

Segurança: Pode definir se é necessária uma palavra-passe para aceder a este documento e o tempo de expiração deste documento. Se não for selecionado nenhum tempo de expiração, nunca expira.

Mostrar campos da API: Pode definir se estes campos são apresentados no documento. Inclui: Proprietários, Hora de atualização, OperationId, Ligação original, Autorização necessária.

Idioma: A definição de idioma aqui afetará o texto funcional fixo no documento, como "Query Params", "Request samples", etc., mas não afetará o texto escrito no conteúdo da documentação da API.

Proxy CORS: Pode implementar e configurar o servidor proxy CORS para processar pedidos de endpoints na documentação da API. Saiba mais.

Definições avançadas: Configure opções como Ocultar o botão "Try it out" e Ocultar "Powered by Apidog".

Exemplos de pedidos

Pode escolher se pretende apresentar exemplos de código de pedidos ao criar a partilha.
Como personalizar exemplos de pedidos:

Em Definições → Definições de funcionalidades → Definições de funcionalidades de endpoint → Campos de endpoint, ative o campo Exemplos de pedidos

Em Endpoint → Editar, será apresentado um módulo Exemplos de pedidos no final

Clique em Exemplos de código de pedido personalizados para adicionar exemplos nos seus idiomas preferidos

Partilhar a pasta inteira

A Partilha Rápida suporta Share entire folder, o que é ideal para cenários em que continua a adicionar ou remover documentos após a partilha. Quando ativado, os colaboradores acedem automaticamente a toda a documentação na pasta, sem ser necessário ajustar as definições de partilha para cada novo documento.

Na secção Scope to Share, selecione Manual Selection para ver a opção Share entire folder. Quando ativado, os colaboradores acedem automaticamente a toda a documentação na pasta.

Configuração do proxy CORS

Ao partilhar documentação de API com utilizadores externos, estes podem encontrar problemas de Cross-Origin Resource Sharing (CORS) ao testar endpoints diretamente no navegador. Um proxy CORS resolve isto ao encaminhar pedidos através de um agente proxy designado, contornando as restrições CORS do navegador e permitindo testes de API sem interrupções.

Para configurar o proxy CORS, clique na opção de definição ao criar uma nova documentação partilhada. Por predefinição, o Apidog disponibiliza Cloud Agent para gerir pedidos de endpoints em toda a documentação partilhada.

Opções de proxy CORS

Selecione a opção de proxy CORS que melhor se adequa às suas necessidades:

Cloud Proxy: Utiliza o Cloud Agent da Apidog para processar pedidos de endpoints. Nota: o Cloud Agent não consegue aceder a endpoints em redes internas

Extensões do navegador: Utiliza uma extensão do navegador instalada no navegador do utilizador. Os utilizadores sem a extensão serão solicitados a instalá-la antes de efetuarem pedidos

Sem proxy: Os pedidos são enviados diretamente a partir do navegador do utilizador. Certifique-se de que o seu servidor de endpoints está configurado para processar CORS corretamente

Agente proxy de pedidos autoalojado: Utilize um Agente proxy de pedidos autoalojado implementado na sua infraestrutura para processar pedidos de endpoints

Pré-requisitos#

Criar uma Partilha Rápida#

Opções de configuração#

Exemplos de pedidos#

Partilhar a pasta inteira#

Configuração do proxy CORS#

Opções de proxy CORS#

Pré-requisitos

Criar uma Partilha Rápida

Opções de configuração

Exemplos de pedidos

Partilhar a pasta inteira

Configuração do proxy CORS

Opções de proxy CORS