Importere et API
Restorm gjenkjenner tjuefire formater og bygger et komplett prosjekttre ut fra dem: mapper, forespørsler, miljøer, API-dokumentasjon og enumerasjoner.
Det er nesten alltid det beste utgangspunktet: ikke skriv forespørslene dine for hånd hvis det finnes en spesifikasjon.
Slik importerer du
Section titled “Slik importerer du”Fil ▸ Importer (Ctrl+I) tar imot:
- en fil fra disken;
- en URL — nyttig for en
swagger.jsoneller et$metadatasom ligger på nett; - innlimt innhold — det er slik du gjør en
curl-kommando om til en forespørsel.
Restorm oppdager formatet selv: først ut fra filendelsen, deretter ved å analysere innholdet. Du trenger ikke velge noe.
Formatene
Section titled “Formatene”API-spesifikasjoner
Section titled “API-spesifikasjoner”| Format | Side |
|---|---|
| OpenAPI 3.x og Swagger 2.0 | OpenAPI / Swagger |
| GraphQL-skjema (SDL) | GraphQL |
.proto-filer og gRPC-reflection | gRPC |
| WSDL | SOAP / WSDL |
| AsyncAPI | AsyncAPI |
| OData EDMX / CSDL | OData |
| OpenRPC | OpenRPC |
| tRPC-skjema | 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 |
Opptak og kommandolinjer
Section titled “Opptak og kommandolinjer”| Format | Side |
|---|---|
| HAR (nettleseropptak) | HAR |
curl-kommandoer | cURL |
Invoke-RestMethod / Invoke-WebRequest | PowerShell |
Hva du får
Section titled “Hva du får”Avhengig av hvor rikt kildeformatet er:
- en miljømappe med ett eller flere miljøer, og basis-URL-en hentet fra spesifikasjonen;
- et mappetre — etter etikett, etter tjeneste eller etter ressurs, alt etter formatet;
- én forespørsel per operasjon, av typen som svarer til protokollen;
- API-dokumentasjonen knyttet til mappen: modeller, beskrivelser, sikkerhetsskjemaer og eksempelsvar;
- spesifikasjonens enumerasjoner, som kan gjenbrukes som verditype;
- ferdigkoblede autentiseringsheadere med variablene sine — se Autentisering.
Etter importen blir alle nøkkel/verdi-par som løses opp til en tom verdi automatisk deaktivert: den første forespørselen du sender, går altså ikke ut med en sverm av tomme headere.
Dokumentasjonen for det importerte API-et
Section titled “Dokumentasjonen for det importerte API-et”En import gir ikke bare forespørsler: den beholder API-ets dokumentasjon — beskrivelser, modeller, sikkerhet, eksempler og enumerasjoner — som du finner i fanen Docs i mappen som ble opprettet. Se Tilgang til og oppdatering av dokumentasjonen for et importert API.
Oppdatere en import
Section titled “Oppdatere en import”Tolv formater kan synkroniseres på nytt: Restorm sammenligner den nye versjonen av kilden med det eksisterende treet og bruker deltaet, uten å miste endringene dine. Se Oppdatere fra kilden.
Og eksport?
Section titled “Og eksport?”Restorm genererer kodesnutter for hver forespørsel, på alle språk som er relevante for protokollen dens. Se Kodeeksport.