Importar uma API
O Restorm reconhece vinte e quatro formatos e reconstrói a partir deles uma árvore de projeto completa: pastas, pedidos, ambientes, documentação de API, enumerações.
É quase sempre o melhor ponto de partida: não escreva os seus pedidos à mão se já existir uma especificação.
Como importar
Section titled “Como importar”Ficheiro ▸ Importar (Ctrl+I) aceita:
- um ficheiro do disco;
- um URL — útil para um
swagger.jsonou um$metadataservido em linha; - conteúdo colado — é assim que se transforma um comando
curlnum pedido.
O Restorm deteta o formato por si só: primeiro pela extensão do ficheiro e depois analisando o conteúdo. Não tem de escolher nada.
Os formatos
Section titled “Os formatos”Especificações de API
Section titled “Especificações de API”| Formato | Página |
|---|---|
| OpenAPI 3.x e Swagger 2.0 | OpenAPI / Swagger |
| Esquema GraphQL (SDL) | GraphQL |
Ficheiros .proto e reflexão gRPC | gRPC |
| WSDL | SOAP / WSDL |
| AsyncAPI | AsyncAPI |
| OData EDMX / CSDL | OData |
| OpenRPC | OpenRPC |
| Esquema tRPC | tRPC |
| Smithy | Smithy |
| TypeSpec | TypeSpec |
| RAML | RAML |
| WADL | WADL |
| Thrift | Thrift |
| API Blueprint | API Blueprint |
Coleções de outros clientes
Section titled “Coleções de outros clientes”| Formato | Página |
|---|---|
| Postman | Postman |
| Insomnia | Insomnia |
| Bruno | Bruno |
| Thunder Client | Thunder Client |
| Paw / RapidAPI | Paw |
| HTTPie | HTTPie |
VS Code REST Client (.http) | REST Client |
Capturas e linhas de comandos
Section titled “Capturas e linhas de comandos”| Formato | Página |
|---|---|
| HAR (captura do navegador) | HAR |
Comandos curl | cURL |
Invoke-RestMethod / Invoke-WebRequest | PowerShell |
O que obtém
Section titled “O que obtém”Conforme a riqueza do formato de origem:
- uma pasta de variáveis com um ou vários ambientes e o URL de base extraído da especificação;
- uma árvore de pastas — por etiqueta, por serviço ou por recurso, segundo o formato;
- um pedido por operação, do tipo correspondente ao protocolo;
- a documentação de API anexada à pasta: modelos, descrições, esquemas de segurança, respostas de exemplo;
- as enumerações da especificação, reutilizáveis como tipo de valor;
- os cabeçalhos de autenticação já preparados com as respetivas variáveis — consulte Autenticação.
Depois da importação, todo o par chave / valor cujo valor se resolva como vazio é desativado automaticamente: o seu primeiro envio não parte, portanto, com uma nuvem de cabeçalhos vazios.
A documentação da API importada
Section titled “A documentação da API importada”Uma importação não produz apenas pedidos: conserva a documentação da API — descrições, modelos, segurança, exemplos, enumerações — consultável no separador Docs da pasta criada. Consulte Acesso e atualização da documentação de uma API importada.
Atualizar uma importação
Section titled “Atualizar uma importação”Doze formatos aceitam ser ressincronizados: o Restorm compara a nova versão da origem com a árvore existente e aplica o delta, sem perder as suas alterações. Consulte Atualizar a partir da origem.
E a exportação?
Section titled “E a exportação?”O Restorm gera fragmentos de código para cada pedido, em todas as linguagens pertinentes para o respetivo protocolo. Consulte Exportação de código.