Eine API importieren
Restorm erkennt vierundzwanzig Formate und baut daraus einen vollständigen Projektbaum wieder auf: Ordner, Anfragen, Umgebungen, API-Dokumentation, Aufzählungen.
Das ist fast immer der beste Ausgangspunkt: Schreiben Sie Ihre Anfragen nicht von Hand, wenn eine Spezifikation existiert.
So importieren Sie
Section titled “So importieren Sie”Datei ▸ Importieren (Ctrl+I) akzeptiert:
- eine Datei von der Festplatte;
- eine URL — nützlich für ein online bereitgestelltes
swagger.jsonoder$metadata; - eingefügten Inhalt — so verwandelt man einen
curl-Befehl in eine Anfrage.
Restorm erkennt das Format selbstständig: zunächst anhand der Dateiendung, dann durch Analyse des Inhalts. Sie müssen nichts auswählen.
Die Formate
Section titled “Die Formate”API-Spezifikationen
Section titled “API-Spezifikationen”| Format | Seite |
|---|---|
| OpenAPI 3.x und Swagger 2.0 | OpenAPI / Swagger |
| GraphQL-Schema (SDL) | GraphQL |
.proto-Dateien und gRPC-Reflexion | 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 |
Sammlungen anderer Clients
Section titled “Sammlungen anderer Clients”| Format | Seite |
|---|---|
| Postman | Postman |
| Insomnia | Insomnia |
| Bruno | Bruno |
| Thunder Client | Thunder Client |
| Paw / RapidAPI | Paw |
| HTTPie | HTTPie |
VS Code REST Client (.http) | REST Client |
Mitschnitte und Kommandozeilen
Section titled “Mitschnitte und Kommandozeilen”| Format | Seite |
|---|---|
| HAR (Browser-Mitschnitt) | HAR |
curl-Befehle | cURL |
Invoke-RestMethod / Invoke-WebRequest | PowerShell |
Was Sie erhalten
Section titled “Was Sie erhalten”Je nach Ausdrucksstärke des Quellformats:
- einen Variablenordner mit einer oder mehreren Umgebungen und der aus der Spezifikation extrahierten Basis-URL;
- eine Ordnerstruktur — nach Tag, nach Dienst, nach Ressource, je nach Format;
- eine Anfrage pro Operation, vom Typ passend zum Protokoll;
- die am Ordner angehängte API-Dokumentation: Modelle, Beschreibungen, Sicherheitsschemata, Beispielantworten;
- die Aufzählungen der Spezifikation, wiederverwendbar als Werttyp;
- die vorverdrahteten Authentifizierungsheader mit ihren Variablen — siehe Authentifizierung.
Nach dem Import wird jedes Schlüssel-Wert-Paar, dessen Wert sich zu leer auflöst, automatisch deaktiviert: Ihr erstes Senden startet also nicht mit einer Wolke leerer Header.
Die Dokumentation der importierten API
Section titled “Die Dokumentation der importierten API”Ein Import erzeugt nicht nur Anfragen: Er bewahrt die Dokumentation der API — Beschreibungen, Modelle, Sicherheit, Beispiele, Aufzählungen —, die im Tab Docs des erstellten Ordners einsehbar ist. Siehe Zugriff auf und Aktualisierung der Dokumentation einer importierten API.
Einen Import aktualisieren
Section titled “Einen Import aktualisieren”Zwölf Formate lassen sich neu synchronisieren: Restorm vergleicht die neue Version der Quelle mit dem bestehenden Baum und wendet das Delta an, ohne Ihre Änderungen zu verlieren. Siehe Aktualisierung aus der Quelle.
Und der Export?
Section titled “Und der Export?”Restorm erzeugt Code-Snippets für jede Anfrage, in allen für ihr Protokoll relevanten Sprachen. Siehe Code-Export.