OpenAPI / Swagger importieren
Das ist der umfassendste Import von Restorm. Drei Versionen werden erkannt: Swagger 2.0, OpenAPI 3.0 und OpenAPI 3.1.
Importieren
Section titled “Importieren”Datei ▸ Importieren (Ctrl+I), dann eine Datei swagger.json /
openapi.json oder direkt die URL der Spezifikation.
Antwortet die URL mit 401 oder 403, bietet Restorm an, eine
Authentifizierung anzuhängen und es erneut zu versuchen, ohne den
Import-Dialog zu verlassen.
Was importiert wird
Section titled “Was importiert wird”| Element der Spezifikation | Was Restorm daraus macht |
|---|---|
servers (oder host + basePath + schemes) | Die Basis-URL der Umgebung, aufgelöste Servervariablen |
tags | Ein Ordner pro Tag, plus ein Ordner Other für den Rest |
| Jede Operation | Eine HTTP-Anfrage, inklusive Methode und Pfad |
| Parameter | Pfad-, Query- und Header-Parameter, typisiert (Zeichenkette, Zahl, Datum/Uhrzeit, Aufzählung, Secret …) |
requestBody | Der Body, in seinem Content-Type |
examples | Der Body vorausgefüllt mit dem gelieferten Beispiel |
components / definitions | Die API-Dokumentation: Modelle, Beschreibungen |
enum | Wiederverwendbare Aufzählungen als Werttyp |
| Antworten | Dokumentiert nach Content-Type |
$ref-Verweise werden aufgelöst, auch über Components hinweg.
Die Zeile components / definitions verdient Hervorhebung: Der Import
beschränkt sich nicht auf die Anfragen, sondern bewahrt die gesamte
API-Dokumentation — Beschreibungen, Modelle, Sicherheitsschemata,
Beispiele, Aufzählungen. Sie ist im Tab Docs des aus dem Import
stammenden Variablenordners ebenso einsehbar wie in dem jeder Anfrage und
wird von der Quelle aus resynchronisiert. Siehe
Zugriff auf und Aktualisierung der Dokumentation einer importierten API.
Sicherheit
Section titled “Sicherheit”Deklarierte Sicherheitsschemata werden in vorverdrahtete Header oder Parameter übersetzt, mit der entsprechenden für Sie erstellten Umgebungsvariable:
| Schema | Was Restorm anlegt |
|---|---|
apiKey per Header oder Query | Ein nach dem Schema benanntes Paar, Wert {{<schema>}} |
http + basic | Authorization: Basic {{<schema>_credentials}} |
http + bearer, oauth2, openIdConnect | Authorization: Bearer {{<schema>_token}} |
Es bleibt nur, die Variable auszufüllen — oder sie durch eine Authentifizierungsroute zu ersetzen, um von der automatischen Erneuerung zu profitieren.
Aktualisieren
Section titled “Aktualisieren”OpenAPI und Swagger gehören zu den resynchronisierbaren Formaten: Die Schaltfläche Aktualisieren des Ordners ruft die Quelle ab, und Restorm wendet das Delta an — neue Operationen werden hinzugefügt, verschwundene Operationen als veraltet markiert statt gelöscht, Ihre Änderungen bleiben erhalten. Siehe Aktualisierung aus der Quelle.