Importarea unui API
Restorm recunoaște douăzeci și patru de formate și reconstruiește din ele un arbore de proiect complet: foldere, cereri, medii, documentație de API, enumerări.
Este aproape întotdeauna cel mai bun punct de plecare: nu vă scrieți cererile de mână dacă există o specificație.
Cum se importă
Section titled “Cum se importă”Fișier ▸ Importă (Ctrl+I) acceptă:
- un fișier de pe disc;
- un URL — util pentru un
swagger.jsonsau un$metadataservit online; - conținut lipit — astfel se transformă o comandă
curlîntr-o cerere.
Restorm detectează singur formatul: mai întâi după extensia fișierului, apoi analizând conținutul. Nu aveți nimic de ales.
Formatele
Section titled “Formatele”Specificații de API
Section titled “Specificații de API”| Format | Pagină |
|---|---|
| OpenAPI 3.x și Swagger 2.0 | OpenAPI / Swagger |
| Schemă GraphQL (SDL) | GraphQL |
Fișiere .proto și reflexie gRPC | gRPC |
| WSDL | SOAP / WSDL |
| AsyncAPI | AsyncAPI |
| OData EDMX / CSDL | OData |
| OpenRPC | OpenRPC |
| Schemă tRPC | tRPC |
| Smithy | Smithy |
| TypeSpec | TypeSpec |
| RAML | RAML |
| WADL | WADL |
| Thrift | Thrift |
| API Blueprint | API Blueprint |
Colecții ale altor clienți
Section titled “Colecții ale altor clienți”| Format | Pagină |
|---|---|
| Postman | Postman |
| Insomnia | Insomnia |
| Bruno | Bruno |
| Thunder Client | Thunder Client |
| Paw / RapidAPI | Paw |
| HTTPie | HTTPie |
VS Code REST Client (.http) | REST Client |
Capturi și linii de comandă
Section titled “Capturi și linii de comandă”| Format | Pagină |
|---|---|
| HAR (captură din browser) | HAR |
Comenzi curl | cURL |
Invoke-RestMethod / Invoke-WebRequest | PowerShell |
Ce obțineți
Section titled “Ce obțineți”În funcție de bogăția formatului sursă:
- un folder de variabile cu unul sau mai multe medii, cu URL-ul de bază extras din specificație;
- un arbore de foldere — pe etichetă, pe serviciu, pe resursă, în funcție de format;
- o cerere pentru fiecare operație, de tipul corespunzător protocolului;
- documentația de API atașată folderului: modele, descrieri, scheme de securitate, răspunsuri de exemplu;
- enumerările din specificație, reutilizabile ca tip de valoare;
- antetele de autentificare precablate, cu variabilele lor — vedeți Autentificare.
După import, orice pereche cheie / valoare a cărei valoare se rezolvă la un șir vid este dezactivată automat: prima dumneavoastră trimitere nu pleacă, prin urmare, cu un roi de antete goale.
Documentația API-ului importat
Section titled “Documentația API-ului importat”Un import nu produce doar cereri: el păstrează documentația API-ului — descrieri, modele, securitate, exemple, enumerări — consultabilă în fila Docs a folderului creat. Vedeți Accesul și actualizarea documentației unui API importat.
Actualizarea unui import
Section titled “Actualizarea unui import”Douăsprezece formate acceptă să fie re-sincronizate: Restorm compară noua versiune a sursei cu arborele existent și aplică delta, fără să vă piardă modificările. Vedeți Actualizarea din sursă.
Și exportul?
Section titled “Și exportul?”Restorm generează fragmente de cod pentru fiecare cerere, în toate limbajele relevante pentru protocolul său. Vedeți Export de cod.