Import og eksport
Restorm genkender fireogtyve formater og genopbygger ud fra dem en komplet projekttræstruktur: mapper, anmodninger, miljøer, API-dokumentation, opremsninger.
Det er næsten altid det bedste udgangspunkt: lad være med at skrive dine anmodninger i hånden, hvis der findes en specifikation.
Sådan importerer du
Section titled “Sådan importerer du”Fil ▸ Importér (Ctrl+I) accepterer:
- en fil fra disken;
- en URL — nyttigt til en
swagger.jsoneller en$metadata, der serveres online; - indsat indhold — det er sådan, man forvandler en
curl-kommando til en anmodning.
Restorm genkender selv formatet: først ud fra filens endelse og derefter ved at analysere indholdet. Du skal ikke vælge noget.
Formaterne
Section titled “Formaterne”API-specifikationer
Section titled “API-specifikationer”| Format | Side |
|---|---|
| OpenAPI 3.x og Swagger 2.0 | OpenAPI / Swagger |
| GraphQL-skema (SDL) | GraphQL |
.proto-filer og gRPC-refleksion | gRPC |
| WSDL | SOAP / WSDL |
| AsyncAPI | AsyncAPI |
| OData EDMX / CSDL | OData |
| OpenRPC | OpenRPC |
| tRPC-skema | tRPC |
| Smithy | Smithy |
| TypeSpec | TypeSpec |
| RAML | RAML |
| WADL | WADL |
| Thrift | Thrift |
| API Blueprint | API Blueprint |
Samlinger fra andre klienter
Section titled “Samlinger fra andre klienter”| Format | Side |
|---|---|
| Postman | Postman |
| Insomnia | Insomnia |
| Bruno | Bruno |
| Thunder Client | Thunder Client |
| Paw / RapidAPI | Paw |
| HTTPie | HTTPie |
VS Code REST Client (.http) | REST Client |
Optagelser og kommandolinjer
Section titled “Optagelser og kommandolinjer”| Format | Side |
|---|---|
| HAR (browseroptagelse) | HAR |
curl-kommandoer | cURL |
Invoke-RestMethod / Invoke-WebRequest | PowerShell |
Hvad du får
Section titled “Hvad du får”Alt efter hvor rigt kildeformatet er:
- en miljømappe med et eller flere miljøer og basis-URL’en trukket ud af specifikationen;
- en mappestruktur — pr. tag, pr. tjeneste eller pr. ressource afhængigt af formatet;
- én anmodning pr. operation, af den type, der svarer til protokollen;
- API-dokumentationen knyttet til mappen: modeller, beskrivelser, sikkerhedsskemaer, eksempelsvar;
- specifikationens opremsninger, som kan genbruges som værditype;
- de forudkoblede godkendelsesheadere med deres variabler — se Godkendelse.
Efter importen slås ethvert nøgle/værdi-par, hvis værdi opløses til tomt, automatisk fra: din første afsendelse går altså ikke af sted med en sværm af tomme headere.
Dokumentationen for det importerede API
Section titled “Dokumentationen for det importerede API”En import producerer ikke kun anmodninger: den bevarer API’ets dokumentation — beskrivelser, modeller, sikkerhed, eksempler, opremsninger — som kan læses på fanen Docs i den oprettede mappe. Se Adgang til og opdatering af dokumentationen for et importeret API.
Opdatér en import
Section titled “Opdatér en import”Tolv formater kan gensynkroniseres: Restorm sammenligner den nye version af kilden med den eksisterende træstruktur og anvender forskellen uden at miste dine ændringer. Se Opdatér fra kilden.
Og eksporten?
Section titled “Og eksporten?”Restorm genererer kodestykker for hver anmodning, i alle de sprog, der er relevante for dens protokol. Se Kodeeksport.