Importare un’API
Restorm riconosce ventiquattro formati e ricostruisce a partire da essi un albero di progetto completo: cartelle, richieste, ambienti, documentazione di API, enumerazioni.
È quasi sempre il punto di partenza migliore: meglio non scrivere le richieste a mano se esiste una specifica.
Come importare
Section titled “Come importare”File ▸ Importa (Ctrl+I) accetta:
- un file del disco;
- un URL — utile per uno
swagger.jsono un$metadataservito online; - del contenuto incollato — è così che si trasforma un comando
curlin una richiesta.
Restorm rileva il formato da solo: prima in base all’estensione del file, poi analizzando il contenuto. Non c’è nulla da scegliere.
I formati
Section titled “I formati”Specifiche di API
Section titled “Specifiche di API”| Formato | Pagina |
|---|---|
| OpenAPI 3.x e Swagger 2.0 | OpenAPI / Swagger |
| Schema GraphQL (SDL) | GraphQL |
File .proto e reflection gRPC | gRPC |
| WSDL | SOAP / WSDL |
| AsyncAPI | AsyncAPI |
| OData EDMX / CSDL | OData |
| OpenRPC | OpenRPC |
| Schema tRPC | tRPC |
| Smithy | Smithy |
| TypeSpec | TypeSpec |
| RAML | RAML |
| WADL | WADL |
| Thrift | Thrift |
| API Blueprint | API Blueprint |
Collezioni di altri client
Section titled “Collezioni di altri client”| Formato | Pagina |
|---|---|
| Postman | Postman |
| Insomnia | Insomnia |
| Bruno | Bruno |
| Thunder Client | Thunder Client |
| Paw / RapidAPI | Paw |
| HTTPie | HTTPie |
VS Code REST Client (.http) | REST Client |
Catture e righe di comando
Section titled “Catture e righe di comando”| Formato | Pagina |
|---|---|
| HAR (cattura del browser) | HAR |
Comandi curl | cURL |
Invoke-RestMethod / Invoke-WebRequest | PowerShell |
Che cosa si ottiene
Section titled “Che cosa si ottiene”In base alla ricchezza del formato di origine:
- una cartella di variabili con uno o più ambienti e l’URL di base estratto dalla specifica;
- un albero di cartelle — per etichetta, per servizio, per risorsa a seconda del formato;
- una richiesta per operazione, del tipo corrispondente al protocollo;
- la documentazione di API allegata alla cartella: modelli, descrizioni, schemi di sicurezza, risposte di esempio;
- le enumerazioni della specifica, riutilizzabili come tipo di valore;
- gli header di autenticazione precablati con le loro variabili — si veda Autenticazione.
Dopo l’importazione, ogni coppia chiave / valore il cui valore si risolve a vuoto viene disattivata automaticamente: il primo invio non parte quindi con uno sciame di header vuoti.
La documentazione dell’API importata
Section titled “La documentazione dell’API importata”Un’importazione non produce soltanto richieste: conserva la documentazione dell’API — descrizioni, modelli, sicurezza, esempi, enumerazioni — consultabile nella scheda Docs della cartella creata. Si veda Accesso e aggiornamento della documentazione di un’API importata.
Aggiornare un’importazione
Section titled “Aggiornare un’importazione”Dodici formati accettano di essere risincronizzati: Restorm confronta la nuova versione della sorgente con l’albero esistente e applica il delta, senza perdere le modifiche apportate. Si veda Aggiornare dalla sorgente.
E l’esportazione?
Section titled “E l’esportazione?”Restorm genera snippet di codice per ogni richiesta, in tutti i linguaggi pertinenti per il suo protocollo. Si veda Esportazione di codice.