Importar e exportar

Mudar de cliente de APIs não devia significar perder anos de trabalho. O Echo importa a partir das ferramentas que provavelmente já usas e nunca prende os teus dados.

Importa a partir do Postman

O Echo importa coleções e ambientes do Postman, ambos com fidelidade total na importação e na exportação. A estrutura de pastas, os pedidos e as variáveis chegam intactos, e podes voltar a exportar para os formatos do Postman em qualquer altura. Experimentar o Echo não é uma porta de sentido único.

  1. Exporta as tuas coleções e ambientes do Postman.
  2. Importa os ficheiros para o Echo.
  3. Confirma que os pedidos são resolvidos com os ambientes importados e continua a trabalhar.

Importa a partir do Insomnia e do Bruno

Se vens do Insomnia ou do Bruno, o processo é o mesmo: exporta a partir da ferramenta atual e importa para o Echo. Os pedidos ficam em coleções que podes reorganizar imediatamente com as ferramentas descritas em /docs/echo/collections-and-sharing.

Importa uma especificação OpenAPI 3

Fornece ao Echo um documento OpenAPI 3, em JSON ou YAML, e ele cria pedidos a partir da especificação com inferência automática do tipo de pedido. Assim, as operações entram como o tipo de pedido correto, em vez de um conjunto de esboços genéricos. É a forma mais rápida de começares a explorar uma API cujo contrato já tens, mas que nunca chamaste.

Importa um comando cURL

Cola um comando cURL e o Echo transforma-o num pedido completo. É útil para os comandos que vivem em relatórios de erros, documentação de APIs e históricos do terminal. Se a tua organização tiver lugares Pro AI, também há importação de cURL assistida por IA para os casos mais confusos. Consulta /docs/echo/ai-features.

Exporta o teu trabalho

Exporta coleções para os formatos do Postman ou para OpenAPI 3.1 em JSON. Com OpenAPI, obténs uma especificação para usar noutras ferramentas de APIs. A exportação para Postman mantém disponível o teu fluxo de trabalho com coleções.

Mantém uma coleção numa pasta

Liga uma coleção a uma pasta para manter pedidos e ambientes em ficheiros JSON legíveis junto do teu projeto. Podes rever as alterações com as ferramentas habituais e incluir os ficheiros no controlo de versões.

O Echo mostra se houve alterações na aplicação, na pasta ou nas duas. Escolhe importar ou exportar para as aplicar; ligar uma pasta não faz commit nem push no Git. Os valores secretos ficam fora dos ficheiros exportados. Usa referências a variáveis para credenciais e revê os ficheiros antes de partilhar.

Publica documentação de APIs no DocuVault

A exportação de documentação publica uma coleção como documentação de API em Markdown no Gapfy DocuVault. Em vez de uma página de wiki que fica desatualizada, o espaço de documentos da tua equipa recebe documentação gerada a partir da coleção que realmente executas.

  1. Escolhe a coleção que queres documentar.
  2. Executa a exportação de documentação.
  3. Encontra no DocuVault a documentação de API em Markdown gerada, pronta para partilhares com a equipa.

Partilha documentação por ligação

Com um plano pago do Echo e as permissões necessárias, publica a documentação de uma coleção sincronizada e copia a ligação pública. Podes publicar uma versão atualizada, trocar a ligação ou revogar a publicação. Qualquer pessoa com a ligação pública pode ler o conteúdo, por isso revê o material antes de partilhar. Esta publicação é separada da exportação de Markdown para o DocuVault.

Próximos passos

  • Organiza o que importaste: /docs/echo/collections-and-sharing
  • Liga os pedidos importados aos ambientes: /docs/echo/environments-and-variables