Compartilhamento rápido

A colaboração eficaz em APIs exige compartilhamento de documentação sem atritos. O Compartilhamento rápido elimina a ineficiência de enviar arquivos Word ou PDF ao fornecer links instantâneos de documentação online. Esse recurso permite comunicação rápida entre equipes, possibilitando que você compartilhe endpoints de API específicos com colaboradores, mantendo o controle sobre acesso, visibilidade e expiração.

Pré-requisitos

Antes de criar um Compartilhamento rápido, certifique-se de que você tenha:

Uma conta Apidog com acesso a um projeto

Endpoints de API ou documentação para compartilhar

(Opcional) Ambientes configurados, caso você queira que os leitores testem endpoints

Criando um Compartilhamento rápido

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

Clique em +Novo para criar um novo Compartilhamento rápido. Um projeto oferece suporte a vários Compartilhamentos rápidos, que podem ser distribuídos para diferentes colaboradores. Todos os membros da equipe podem visualizar Compartilhamentos rápidos criados por qualquer pessoa da equipe.

Opções de configuração

Na caixa de diálogo Novo compartilhamento, você pode personalizar as seguintes opções:

Título: O nome deste compartilhamento, visível apenas dentro da equipe Apidog, usado para identificação interna, não visível na documentação compartilhada.

Ambientes: Escolha os ambientes disponíveis no documento online. Por padrão, nenhum ambiente é selecionado. Você pode selecionar vários ambientes. Os ambientes selecionados ficarão visíveis para os leitores na documentação e poderão ser usados para enviar requisições ao usar "Experimentar".

Ambiente de mock na nuvem

Se você selecionar o ambiente de mock na nuvem ao criar a documentação, estará fornecendo aos leitores um ambiente de sandbox simples para testar APIs sem afetar sistemas de produção.

Conteúdo do documento: O documento tem dois componentes opcionais: URL base e exemplos de requisição. Você pode escolher se deseja exibi-los no documento.

URL base: Esta é a URL base definida no ambiente. Se selecionada, cada interface no documento mostrará a URL completa; se não for selecionada, a URL no documento começará com "/".

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

Exemplos de requisição: Se deve exibir código de exemplo para chamar requisições. Consulte exemplos de requisição para obter detalhes.

Mostrar o horário da 'Última modificação' acima da descrição do endpoint.

Mostrar o horário da 'Última modificação' no final da documentação.

Permitir dados de 'Exportação' e 'Clonagem': Se deve permitir que os leitores exportem e clonem dados em formato OAS/Markdown/HTML/Apidog.

Escopo para compartilhar: Escolha quais endpoints de API e Markdown incluir neste compartilhamento. Você pode selecionar por diretório ou filtro e excluir por tag. Você também pode optar por compartilhar a pasta inteira.

Segurança: Você pode definir se uma senha é necessária para acessar este documento e o tempo de expiração deste documento. Se nenhum tempo de expiração for selecionado, ele nunca expirará.

Mostrar campos da API: Você pode definir se esses campos serão exibidos no documento. Inclui: Proprietários, Horário de atualização, OperationId, Link original, Autorização necessária.

Idioma: A configuração de idioma aqui afetará o texto fixo funcional 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: Você pode implantar e configurar o servidor proxy CORS para lidar com requisições de endpoint na documentação da API. Saiba mais.

Configurações avançadas: Configure opções como Ocultar botão 'Experimentar' e Ocultar 'Powered by Apidog'.

Exemplos de requisição

Você pode escolher se deseja exibir exemplos de código de requisição ao criar o compartilhamento.
Como personalizar exemplos de requisição:

Em Configurações → Configurações de recursos → Configurações de recursos de endpoint → Campos de endpoint, habilite o campo Exemplos de requisição

Em Endpoint → Editar, um módulo de Exemplos de requisição aparecerá no final

Clique em Exemplos personalizados de código de requisição para adicionar exemplos nos idiomas de sua preferência

Compartilhar a pasta inteira

O Compartilhamento rápido oferece suporte a Compartilhar pasta inteira, o que é ideal para cenários em que você continua adicionando ou removendo documentos após o compartilhamento. Quando habilitado, os colaboradores acessam automaticamente toda a documentação na pasta sem exigir que você ajuste as configurações de compartilhamento para cada novo documento.

Na seção Escopo para compartilhar, selecione Seleção manual para ver a opção Compartilhar pasta inteira. Quando habilitado, os colaboradores acessam automaticamente toda a documentação na pasta.

Configuração de proxy CORS

Ao compartilhar documentação de API com usuários externos, eles podem encontrar problemas de Cross-Origin Resource Sharing (CORS) ao testar endpoints diretamente no navegador. Um proxy CORS resolve isso roteando requisições por meio de um agente proxy designado, contornando as restrições de CORS do navegador e permitindo testes de API sem interrupções.

Para configurar o proxy CORS, clique na opção de configuração ao criar uma nova documentação compartilhada. Por padrão, o Apidog oferece Cloud Agent para gerenciar requisições de endpoint em toda a documentação compartilhada.

Opções de proxy CORS

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

Proxy na nuvem: Usa o Cloud Agent do Apidog para lidar com requisições de endpoint. Observação: o Cloud Agent não consegue acessar endpoints em redes internas

Extensões de navegador: Usa uma extensão de navegador instalada no navegador do usuário. Usuários sem a extensão serão solicitados a instalá-la antes de fazer requisições

Sem proxy: As requisições são enviadas diretamente do navegador do usuário. Certifique-se de que seu servidor de endpoint esteja configurado para lidar corretamente com CORS

Agente de proxy de requisição auto-hospedado: Use um Self-hosted Request Proxy Agent implantado dentro da sua infraestrutura para lidar com requisições de endpoint

Compartilhamento rápido

Pré-requisitos#

Criando um Compartilhamento rápido#

Opções de configuração#

Exemplos de requisição#

Compartilhar a pasta inteira#

Configuração de proxy CORS#

Opções de proxy CORS#

Pré-requisitos

Criando um Compartilhamento rápido

Opções de configuração

Exemplos de requisição

Compartilhar a pasta inteira

Configuração de proxy CORS

Opções de proxy CORS