Importera ett API
Restorm känner igen tjugofyra format och bygger utifrån dem upp ett komplett projektträd: mappar, begäranden, miljöer, API-dokumentation, uppräkningar.
Det är nästan alltid den bästa startpunkten: skriv inte dina begäranden för hand om det redan finns en specifikation.
Så importerar du
Section titled “Så importerar du”Arkiv ▸ Importera (Ctrl+I) tar emot:
- en fil från disken;
- en URL — praktiskt för en
swagger.jsoneller ett$metadatasom ligger online; - inklistrat innehåll — så förvandlar du ett
curl-kommando till en begäran.
Restorm känner igen formatet av sig själv: först utifrån filändelsen, sedan genom att analysera innehållet. Du behöver inte välja något.
Formaten
Section titled “Formaten”API-specifikationer
Section titled “API-specifikationer”| Format | Sida |
|---|---|
| OpenAPI 3.x och Swagger 2.0 | OpenAPI / Swagger |
| GraphQL-schema (SDL) | GraphQL |
.proto-filer och gRPC-reflektion | gRPC |
| WSDL | SOAP / WSDL |
| AsyncAPI | AsyncAPI |
| OData EDMX / CSDL | OData |
| OpenRPC | OpenRPC |
| tRPC-schema | tRPC |
| Smithy | Smithy |
| TypeSpec | TypeSpec |
| RAML | RAML |
| WADL | WADL |
| Thrift | Thrift |
| API Blueprint | API Blueprint |
Samlingar från andra klienter
Section titled “Samlingar från andra klienter”| Format | Sida |
|---|---|
| Postman | Postman |
| Insomnia | Insomnia |
| Bruno | Bruno |
| Thunder Client | Thunder Client |
| Paw / RapidAPI | Paw |
| HTTPie | HTTPie |
VS Code REST Client (.http) | REST Client |
Inspelningar och kommandorader
Section titled “Inspelningar och kommandorader”| Format | Sida |
|---|---|
| HAR (webbläsarinspelning) | HAR |
curl-kommandon | cURL |
Invoke-RestMethod / Invoke-WebRequest | PowerShell |
Vad du får
Section titled “Vad du får”Beroende på hur rikt källformatet är:
- en variabelmapp med en eller flera miljöer, där bas-URL:en är hämtad ur specifikationen;
- ett mappträd — per tagg, per tjänst eller per resurs beroende på formatet;
- en begäran per operation, av den typ som motsvarar protokollet;
- API-dokumentationen som fästs vid mappen: modeller, beskrivningar, säkerhetsscheman, exempelsvar;
- specifikationens uppräkningar, som kan återanvändas som värdetyp;
- de färdigkopplade autentiseringsheaders med sina variabler — se Autentisering.
Efter importen inaktiveras automatiskt varje nyckel/värde-par vars värde löses upp till tomt: din första sändning ger sig alltså inte iväg med ett moln av tomma headers.
Dokumentationen för det importerade API:et
Section titled “Dokumentationen för det importerade API:et”En import ger inte bara begäranden: den bevarar API:ets dokumentation — beskrivningar, modeller, säkerhet, exempel, uppräkningar — som går att läsa i fliken Docs i den skapade mappen. Se Läsa och uppdatera dokumentationen för ett importerat API.
Uppdatera en import
Section titled “Uppdatera en import”Tolv format går att synkronisera om: Restorm jämför källans nya version med det befintliga trädet och tillämpar deltat, utan att dina ändringar går förlorade. Se Uppdatera från källan.
Och exporten?
Section titled “Och exporten?”Restorm genererar kodavsnitt för varje begäran, i alla språk som är relevanta för dess protokoll. Se Kodexport.