API importálása
A Restorm huszonnégy formátumot ismer fel, és teljes projektfát épít fel belőlük: mappákat, kéréseket, környezeteket, API-dokumentációt és felsorolásokat.
Szinte mindig ez a legjobb kiindulópont: ha létezik specifikáció, nem érdemes kézzel megírni a kéréseket.
Az importálás menete
Section titled “Az importálás menete”A Fájl ▸ Importálás (Ctrl+I) a következőket fogadja el:
- a gépen lévő fájl;
- egy URL — hasznos az online kiszolgált
swagger.jsonvagy$metadataesetén; - beillesztett tartalom — így alakítható át egy
curlparancs kéréssé.
A Restorm magától felismeri a formátumot: először a fájlkiterjesztés alapján, majd a tartalom elemzésével. Nincs mit kiválasztani.
A formátumok
Section titled “A formátumok”API-specifikációk
Section titled “API-specifikációk”| Formátum | Oldal |
|---|---|
| OpenAPI 3.x és Swagger 2.0 | OpenAPI / Swagger |
| GraphQL-séma (SDL) | GraphQL |
.proto fájlok és gRPC-reflexió | gRPC |
| WSDL | SOAP / WSDL |
| AsyncAPI | AsyncAPI |
| OData EDMX / CSDL | OData |
| OpenRPC | OpenRPC |
| tRPC-séma | tRPC |
| Smithy | Smithy |
| TypeSpec | TypeSpec |
| RAML | RAML |
| WADL | WADL |
| Thrift | Thrift |
| API Blueprint | API Blueprint |
Más kliensek gyűjteményei
Section titled “Más kliensek gyűjteményei”| Formátum | Oldal |
|---|---|
| Postman | Postman |
| Insomnia | Insomnia |
| Bruno | Bruno |
| Thunder Client | Thunder Client |
| Paw / RapidAPI | Paw |
| HTTPie | HTTPie |
VS Code REST Client (.http) | REST Client |
Rögzítések és parancssorok
Section titled “Rögzítések és parancssorok”| Formátum | Oldal |
|---|---|
| HAR (böngészőrögzítés) | HAR |
curl parancsok | cURL |
Invoke-RestMethod / Invoke-WebRequest | PowerShell |
Az eredmény
Section titled “Az eredmény”A forrásformátum kifejezőerejétől függően:
- egy környezeti mappa egy vagy több környezettel és a specifikációból kinyert alap-URL-lel;
- egy mappastruktúra — a formátumtól függően címke, szolgáltatás vagy erőforrás szerint;
- műveletenként egy kérés, a protokollnak megfelelő típusban;
- a mappához csatolt API-dokumentáció: modellek, leírások, biztonsági sémák, példaválaszok;
- a specifikáció felsorolásai, amelyek értéktípusként újra felhasználhatók;
- az előre bekötött hitelesítési fejlécek a hozzájuk tartozó változókkal — lásd: Hitelesítés.
Az importálás után a Restorm automatikusan kikapcsolja minden olyan kulcs-érték párt, amelynek értéke üresre oldódik fel: az első küldés így nem indul üres fejlécek tucatjaival.
Az importált API dokumentációja
Section titled “Az importált API dokumentációja”Az importálás nem csak kéréseket állít elő: megőrzi az API dokumentációját is — leírásokat, modelleket, biztonsági sémákat, példákat, felsorolásokat —, amely a létrejött mappa Dokumentáció lapján tekinthető meg. Lásd: Importált API dokumentációjának elérése és frissítése.
Import frissítése
Section titled “Import frissítése”Tizenkét formátum újraszinkronizálható: a Restorm összehasonlítja a forrás új változatát a meglévő fával, és a különbséget alkalmazza anélkül, hogy a saját módosítások elveszlennének. Lásd: Frissítés a forrásból.
És az exportálás?
Section titled “És az exportálás?”A Restorm minden kéréshez kódrészleteket állít elő, a protokolljához illő összes nyelven. Lásd: Kódexportálás.