Exportar Dados

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

Como Exportar

Navegue até às Definições de Exportação

Aceda a Settings -> Export Data na barra lateral esquerda.

Selecione o Âmbito dos Dados

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

Escolha o Formato e Configure

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

Formatos Suportados

Formato	Versões / Notas
OpenAPI / Swagger	Suporta `3.1`, `3.0` e `2.0`. Exporte como `JSON` ou `YAML`. Inclui suporte para campos de extensão do Apidog.
HTML / Markdown	Gera documentação estática. Ideal para partilha 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, pode clicar em "Open URL" para ver os dados em bruto diretamente no seu navegador.

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

1. Exportar a partir de Ramos Sprint

Para exportar dados de um Ramo Sprint específico:

Mude para o ramo pretendido utilizando o seletor de ramos no canto superior esquerdo.

Aceda a Exportar Dados. O Apidog irá exportar todos os dados do ramo atual.

Nota: Este processo combina o ramo sprint com o ramo principal em memória para garantir a integridade dos dados (resolvendo referências). Não pode selecionar um subconjunto de endpoints ao exportar a partir de um ramo sprint.

2. Configuração OpenAPI Personalizada

Para exportações OpenAPI avançadas, pode configurar regras de inclusão através de Nome do Módulo > Visão Geral > Exportar/Cópia de Segurança da Especificação da API > Adicionar.

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: Porque é que algumas APIs estão em falta na minha exportação?
R: Normalmente, isto acontece se várias APIs partilharem exatamente o mesmo Método e Caminho. A especificação OpenAPI exige combinações Método+Caminho únicas. O Apidog aplica esta regra durante a exportação (especialmente para os formatos HTML/Markdown/OpenAPI). Torne os seus endpoints únicos para resolver esta situação. Saiba mais sobre a Identificação de Endpoints.

P: Porque é que a ordem das APIs é diferente nas exportações Markdown/HTML?
R: Normalmente, a especificação Swagger/OpenAPI subjacente não impõe uma ordenação rigorosa. As exportações Markdown e HTML são geradas com base nestes dados da especificação, o que pode resultar numa ordem de ordenação diferente da que 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, utilizar uma ferramenta como Typora ou Pandoc para converter o ficheiro 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 secção securitySchemes do ficheiro OpenAPI/Swagger. Não é necessário qualquer passo manual.

Como Exportar#

Formatos Suportados#

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

1. Exportar a partir de Ramos Sprint#

2. Configuração OpenAPI Personalizada#

FAQ#

Como Exportar

Formatos Suportados

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

1. Exportar a partir de Ramos Sprint

2. Configuração OpenAPI Personalizada

FAQ