Importação e exportação

O Echo permite trazer pedidos de outro cliente de APIs, manter uma coleção junto do código e gerar documentação para outras pessoas. Estas operações têm resultados e tratamentos de segredos diferentes.

Importar uma coleção ou um ambiente

1. Exporte da ferramenta atual e conserve o ficheiro original.
2. Abra a secção de importação nas definições do Echo, selecione o espaço de destino e o ficheiro de origem. O Echo identifica o formato automaticamente.
3. Confira a pré-visualização, as quantidades e os avisos antes de confirmar.
4. Abra um pedido importado, selecione o ambiente e confirme URL, autenticação, corpo e scripts antes de enviar.

O Echo aceita coleções e ambientes do Postman. A autenticação herdada do Postman é copiada para os pedidos importados quando suportada; não cria autenticação editável na coleção do Echo. Corpos binários e referências a ficheiros não passam simplesmente de um computador para outro e podem ser ignorados com um aviso. Autenticação não suportada também gera um aviso. Volte a associar os ficheiros e ajuste as credenciais antes de usar esses pedidos.

Exportações do Insomnia e coleções do Bruno oferecem outros caminhos de migração. Os modelos de dados são diferentes. Confira o resultado em vez de presumir que todas as funções originais serão preservadas após exportar e voltar a importar.

Começar com OpenAPI ou cURL

Importe um documento OpenAPI 3 em JSON ou YAML para criar pedidos a partir das operações. Confira URLs, parâmetros, corpos e definições de segurança gerados. Uma especificação descreve uma API; importá-la não comprova que o servidor a implementa.

O assistente de importação cURL usa IA e exige um lugar Pro AI. Abra-o pela paleta de comandos ou pelo menu de novo pedido e cole o comando. Reveja URL, método, cabeçalhos e corpo propostos antes de criar o pedido. Confira credenciais e ficheiros referenciados antes de enviar. Consulte funcionalidades de IA para conhecer o acesso e o tratamento dos dados.

Escolher o formato de exportação

A exportação para Postman mantém as coleções disponíveis nessa ferramenta; a exportação de ambientes cria um ficheiro separado. A exportação de ambientes do Postman inclui os valores secretos, marcados como secretos no ficheiro. Trate estes ficheiros como credenciais, não como anexos seguros para partilhar.

A exportação OpenAPI gera um documento OpenAPI 3.1 em JSON para operações HTTP. Os outros protocolos são contabilizados como excluídos; este formato não é uma cópia de segurança de todo o espaço de trabalho. Confira o resultado e a especificação gerada. Os valores secretos de ambiente são omitidos das variáveis de servidor, mas as credenciais escritas diretamente nos pedidos continuam a precisar de revisão.

Associar uma coleção a uma pasta

No menu da coleção, associe uma pasta vazia em que tenha permissão de escrita. O Echo cria ficheiros JSON legíveis para a coleção, os pedidos e os ambientes. Use uma pasta separada para cada árvore associada; associações sobrepostas são recusadas.

O painel da pasta informa alterações no Echo, no disco ou nos dois. Exportar leva a versão do Echo à pasta; importar traz a versão da pasta para o Echo. Se os dois mudaram, reveja o conflito e escolha explicitamente qual versão aplicar. A importação automática é opcional. Remover a associação não elimina a coleção nem os ficheiros da pasta.

Os valores de variáveis secretas são omitidos deste formato, enquanto as referências a segredos podem permanecer. Esta proteção é diferente da exportação de ambientes do Postman. Mantenha as credenciais em variáveis e reveja scripts, corpos e cabeçalhos antes de fazer commit. O Echo não faz commit nem push no Git. O mesmo formato pode ser usado pela CLI do desktop.

Exportar Markdown para o DocuVault

Inicie sessão, selecione uma coleção e escolha a exportação de documentação. O Echo gera Markdown e envia-o para o DocuVault. Um documento existente com o mesmo nome gerado recebe uma nova versão. Confira a mensagem de conclusão e o ficheiro antes de partilhar.

Repita a exportação depois de alterar a coleção. O documento enviado representa aquele momento, não uma vista que acompanha cada edição automaticamente.

Publicar documentação por ligação pública

Para uma coleção sincronizada, o painel permite que pessoas autorizadas num plano pago do Echo publiquem uma versão, copiem o URL, atualizem a publicação, troquem a ligação ou revoguem o acesso. Qualquer pessoa com a ligação pública pode ler o documento. Reveja exemplos e credenciais antes de publicar.

Depois de alterar a coleção, publique novamente para atualizar o conteúdo. Trocar a ligação substitui o URL usado pelos leitores; revogar interrompe o acesso pela publicação. Nenhuma destas ações recolhe cópias já descarregadas. Esta publicação é separada do ficheiro no DocuVault.

Para reutilizar configurações de pedidos, consulte ambientes. Para converter C#, TypeScript, JavaScript, Java, Python ou JSON Schema, consulte contratos.