Een API importeren
Restorm herkent vierentwintig formaten en bouwt daaruit een volledige projectboom op: mappen, verzoeken, omgevingen, API-documentatie, enumeraties.
Dat is bijna altijd het beste vertrekpunt: schrijf uw verzoeken niet met de hand als er een specificatie bestaat.
Hoe u importeert
Section titled “Hoe u importeert”Bestand ▸ Importeren (Ctrl+I) accepteert:
- een bestand van schijf;
- een URL — handig voor een
swagger.jsonof een$metadatadie online wordt aangeboden; - geplakte inhoud — zo verandert u een
curl-opdracht in een verzoek.
Restorm herkent het formaat zelf: eerst op basis van de bestandsextensie, en daarna door de inhoud te analyseren. U hoeft niets te kiezen.
De formaten
Section titled “De formaten”API-specificaties
Section titled “API-specificaties”| Formaat | Pagina |
|---|---|
| OpenAPI 3.x en Swagger 2.0 | OpenAPI / Swagger |
| GraphQL-schema (SDL) | GraphQL |
.proto-bestanden en gRPC-reflection | 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 |
Collecties van andere clients
Section titled “Collecties van andere clients”| Formaat | Pagina |
|---|---|
| Postman | Postman |
| Insomnia | Insomnia |
| Bruno | Bruno |
| Thunder Client | Thunder Client |
| Paw / RapidAPI | Paw |
| HTTPie | HTTPie |
VS Code REST Client (.http) | REST Client |
Opnames en opdrachtregels
Section titled “Opnames en opdrachtregels”| Formaat | Pagina |
|---|---|
| HAR (browseropname) | HAR |
curl-opdrachten | cURL |
Invoke-RestMethod / Invoke-WebRequest | PowerShell |
Wat u krijgt
Section titled “Wat u krijgt”Afhankelijk van de rijkdom van het bronformaat:
- een omgevingsmap met één of meer omgevingen, en de basis-URL uit de specificatie;
- een mappenstructuur — per label, per service of per resource, afhankelijk van het formaat;
- één verzoek per operatie, van het type dat bij het protocol hoort;
- de API-documentatie die aan de map hangt: modellen, beschrijvingen, beveiligingsschema’s, voorbeeldresponsen;
- de enumeraties uit de specificatie, herbruikbaar als waardetype;
- de voorgeschakelde authenticatieheaders met hun variabelen — zie Authenticatie.
Na de import wordt elk sleutel-waardepaar waarvan de waarde leeg blijkt te zijn automatisch uitgeschakeld: uw eerste verzending vertrekt dus niet met een zwerm lege headers.
De documentatie van de geïmporteerde API
Section titled “De documentatie van de geïmporteerde API”Een import levert niet alleen verzoeken op: hij bewaart de documentatie van de API — beschrijvingen, modellen, beveiliging, voorbeelden, enumeraties — die u in het tabblad Docs van de aangemaakte map kunt bekijken. Zie Toegang tot en bijwerken van de documentatie van een geïmporteerde API.
Een import bijwerken
Section titled “Een import bijwerken”Twaalf formaten laten zich opnieuw synchroniseren: Restorm vergelijkt de nieuwe versie van de bron met de bestaande boom en past het verschil toe, zonder uw wijzigingen te verliezen. Zie Bijwerken vanaf de bron.
En de export?
Section titled “En de export?”Restorm genereert codefragmenten voor elk verzoek, in alle talen die voor het bijbehorende protocol relevant zijn. Zie Code-export.