Exportar Dados

O Apidog oferece suporte à exportação de APIs em vários formatos padrão, incluindo OpenAPI Specification, HTML, Markdown, Apidog e Postman, para atender a diferentes necessidades de integração e documentação.

Como Exportar

Navegue até as Configurações de Exportação

Vá para Settings -> Export Data na barra lateral esquerda.

Selecione o Escopo dos Dados

Escolha exportar Todas as APIs ou selecione Endpoints/Tags específicos.

Escolha o Formato e Configure

Selecione o formato desejado (por exemplo, OpenAPI 3.0) e ajuste quaisquer configurações específicas do formato.

Formatos Compatíveis

Formato	Versões / Observações
OpenAPI / Swagger	Oferece suporte a `3.1`, `3.0` e `2.0`. Exporte como `JSON` ou `YAML`. Inclui suporte aos campos de Extensão do Apidog.
HTML / Markdown	Gera documentação estática. Ideal para compartilhamento offline.
Apidog	Formato nativo que contém todos os dados do projeto.
Postman	Exporta coleções compatíveis com o Postman.

Para Documentação Offline, você pode clicar em "Open URL" para visualizar os dados brutos diretamente no seu navegador.

Opções Avançadas de Exportação

1. Exportação a partir de Branches de Sprint

Para exportar dados de uma Branch de Sprint específica:

Mude para a branch desejada usando o seletor de branch no canto superior esquerdo.

Vá para Export Data. O Apidog exportará todos os dados da branch atual.

Observação: Esse processo mescla a branch de sprint com a branch principal na memória para garantir a integridade dos dados (resolvendo referências). Você não pode selecionar um subconjunto de endpoints ao exportar a partir de uma branch de sprint.

2. Configuração Personalizada do OpenAPI

Para exportações avançadas do OpenAPI, você pode configurar regras de inclusão por meio de Nome do Módulo > Visão Geral > Exportar/Fazer Backup da Especificação da API > Adicionar.

Você pode optar por incluir o campo OperationId na exportação, o que é útil para gerar clientes de código. Saiba mais sobre OperationId.

FAQ

P: Por que algumas APIs estão ausentes da minha exportação?
R: Isso geralmente acontece se várias APIs compartilham exatamente o mesmo Método e Caminho. A especificação OpenAPI exige combinações únicas de Método+Caminho. O Apidog aplica essa regra durante a exportação (especialmente para os formatos HTML/Markdown/OpenAPI). Torne seus endpoints únicos para resolver isso. Saiba mais sobre Identificação de Endpoint.

P: Por que a ordem das APIs é diferente nas exportações Markdown/HTML?
R: A especificação Swagger/OpenAPI subjacente geralmente não impõe uma ordenação rígida. As exportações Markdown e HTML são geradas com base nesses dados da especificação, o que pode resultar em uma ordem de classificação diferente da que você vê no cliente Apidog.

P: Posso exportar para PDF ou Word?
R: A exportação direta não é suportada. Recomendamos exportar primeiro para Markdown e, em seguida, usar uma ferramenta como Typora ou Pandoc para converter o arquivo Markdown em PDF, Word ou outros formatos.

P: Os valores de Autenticação são exportados?
R: Sim. O Apidog exporta automaticamente as configurações de Auth para a seção securitySchemes do arquivo OpenAPI/Swagger. Nenhuma etapa manual é necessária.

Como Exportar#

Formatos Compatíveis#

Opções Avançadas de Exportação#

1. Exportação a partir de Branches de Sprint#

2. Configuração Personalizada do OpenAPI#

FAQ#

Como Exportar

Formatos Compatíveis

Opções Avançadas de Exportação

1. Exportação a partir de Branches de Sprint

2. Configuração Personalizada do OpenAPI

FAQ