Importação e exportação

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

Importe uma coleção ou um ambiente

  1. Exporte da ferramenta atual e guarde o arquivo original.
  2. Abra a seção de importação nas configurações do Echo, selecione o espaço de destino e o arquivo de origem. O Echo identifica o formato automaticamente.
  3. Confira a prévia, as quantidades e os avisos antes de confirmar.
  4. Abra uma requisição importada, selecione seu ambiente e confira 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 as requisições importadas quando há suporte; isso não cria autenticação editável na coleção do Echo. Corpos binários e referências a arquivos não podem simplesmente passar de um computador para outro e podem ser ignorados com um aviso. Autenticação sem suporte também gera aviso. Reassocie os arquivos e ajuste as credenciais antes de usar essas requisições.

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 todo recurso original será preservado após exportar e importar novamente.

Comece com OpenAPI ou cURL

Importe um documento OpenAPI 3 em JSON ou YAML para criar requisições a partir das operações. Confira URLs, parâmetros, corpos e configuraçõ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 uma licença Pro AI. Abra-o pela paleta de comandos ou pelo menu de nova requisição e cole o comando. Revise URL, método, cabeçalhos e corpo propostos antes de criar a requisição. Confira credenciais e arquivos referenciados antes de enviar. Consulte recursos de IA para entender o acesso e o tratamento dos dados.

Escolha 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 arquivo separado. A exportação de ambientes do Postman inclui os valores secretos, marcados como secretos no arquivo. Trate esses arquivos como credenciais, não como anexos seguros para compartilhar.

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; esse formato não é um backup de todo o espaço de trabalho. Confira o resultado e a especificação gerada. Valores secretos de ambiente são omitidos das variáveis de servidor, mas credenciais escritas diretamente nas requisições ainda precisam de revisão.

Vincule uma coleção a uma pasta

No menu da coleção, vincule uma pasta vazia em que você tenha permissão de escrita. O Echo cria arquivos JSON legíveis para a coleção, as requisições e os ambientes. Use uma pasta separada para cada árvore vinculada; vínculos sobrepostos são recusados.

O painel da pasta informa mudanças 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, revise o conflito e escolha explicitamente qual versão aplicar. A importação automática é opcional. Desvincular encerra a associação sem excluir a coleção ou os arquivos da pasta.

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

Exporte Markdown para o DocuVault

Entre na conta, selecione uma coleção e escolha a exportação de documentação. O Echo gera Markdown e envia ao DocuVault. Um documento existente com o mesmo nome gerado recebe uma nova versão. Confira a mensagem de conclusão e o arquivo antes de compartilhar.

Repita a exportação depois de mudar a coleção. O documento enviado é um retrato daquele momento, não uma visualização que acompanha cada edição automaticamente.

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

Depois de alterar a coleção, publique novamente para atualizar esse retrato. Trocar o link substitui a URL usada pelos leitores; revogar interrompe o acesso pela publicação. Nenhuma dessas ações recolhe cópias já baixadas. Essa publicação é separada do arquivo no DocuVault.

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