HTTP Requests von OpenAPI aus
Sie können in XMLSpy mit Hilfe des OpenAPI-Assistenten des HTTP-Fensters HTTP Requests anhand eines OpenAPI-Dokuments erstellen.
Erstellen von HTTP Requests
Der Assistent erstellt den Request in drei grundlegenden Schritten auf Basis des OpenAPI-Dokuments und sendet ihn:
1.Wählen Sie aus einem im der OpenAPI-Datei beschriebenen Pfad eine Operation aus.
2.Definieren Sie je nach Operation den Inhaltstyp des Request Body und/oder den Parameter des Request.
3.Senden Sie den Request. Die Antwort (Response) wird im Fenster "Info" des HTTP-Ausgabefensters angezeigt.
In der Anleitung unten sehen Sie, wie Sie anhand einer OpenAPI-Dokument-Datei einen HTTP GET Request erstellen und den Request an einen Webservice senden.
1.Klicken Sie im Fenster "HTTP" auf HTTP Request anhand von WSDL, WADL oder OpenAPI erstellen 
.
2.Geben Sie im daraufhin angezeigten Dialogfeld den Pfad zur OpenAPI-Dokument-Datei ein und klicken Sie auf OK. Zum Beispiel: https://petstore3.swagger.io/api/v3/openapi.json.
3.Wählen Sie im nächsten Dialogfeld Operation auswählen (Abbildung unten) den gewünschten Pfad und die gewünschte Operation aus. So ist etwa der Pfad in der Abbildung unten /pet/findByStatus und die dazugehörige GET-Operation ist die ausgewählte Operation. (Beachten Sie, dass Sie die Pfade im Dialogfeld filtern und die angezeigten Einträge sortieren können).
4.Nachdem Sie auf OK geklickt haben, wird das Dialogfeld HTTP-Request-Parameter angezeigt (Abbildung unten). Die für diesen Parameter im OpenAPI-Dokument definierten Werte werden in der Auswahlliste der Spalte Wert angezeigt. Wählen Sie den gewünschten Wert aus und klicken Sie auf OK.
5.Daraufhin wird der GET Request erstellt und seine URL im oberen Bereich des HTTP-Fensters angezeigt (siehe Abbildung unten).
6.Bei Klick auf Senden wird der Request gesendet und die Response wird rechts im Ergebnisfenster angezeigt (siehe Abbildung unten).
Nähere Informationen dazu finden Sie auch in den folgenden HTTP Kapiteln: Senden des Request und Empfangen der Response. Die Auswahl des Inhaltstyps für PUT und POST Requests wird unter Senden des Request beschrieben.
HTTP Requests von der Text- oder Grid-Ansicht aus
Wenn eine OpenAPI-Datei in der Text- oder Grid-Ansicht geöffnet ist, können Sie direkt von jeder Stelle im Dokument aus einen HTTP Request erstellen. Klicken Sie dazu mit der rechten Maustaste auf die Stelle und wählen Sie den Kontextmenübefehl Neuer HTTP Request. (Abbildung unten).
Der Assistent vervollständigt die erforderlichen Schritte im Verfahren automatisch auf Basis der gewählten Stelle und Sie können mit dem Assistenten ab dem nächsten Schritt fortfahren. So klicken wir etwa in der Abbildung oben mit der rechten Maustaste auf den Pfad /pet/findByStatus, um einen Request für eine der Operationen des Pfads zu erstellen. Der Assistent kennt infolgedessen die Pfadinformationen aus dem OpenAPI-Dokument. Außerdem weiß er, dass unter diesem Pfad eine einzige Operation, nämlich eine GET-Operation mit einem einzigen Parameter (status) zur Verfügung steht. Da nur eine Operation (GET) möglich ist, öffnet sich der Assistet direkt im Schritt Parameters, damit Sie den Wert des Parameters status eingeben können (Abbildung unten). Wenn Sie auf OK klicken, wird der HTTP-Beispiel-Request erstellt und kann gesendet werden.
Der Assistent wird beim ersten Schritt geöffnet, bei dem mehrere Auswahlmöglichkeiten zur Verfügung stehen. Wenn die Auswahl in allen Schritten eindeutig ist (z.B. nur eine Operation und kein Parameter), wird sofort ein Beispiel-Request erstellt und Sie können die Request umgehend senden (indem Sie auf Senden klicken); andernfalls können Sie den Request ändern und anschließend senden.
Multipart HTTP Requests von einer OpenAPI-Datei aus
Wenn laut der Beschreibung eines POST Request in einer OpenAPI-Datei mehrere Dateien oder eine Mischung von Daten (z.B. JSON- und Binärdatei) hochgeladen werden müssen, erstellt der OpenAPI-Assistent den POST Request als multipart/form-data Request. Sie können den Request über das HTTP-Fenster oder die Text- oder Grid-Ansicht erstellen. Das Verfahren ist ähnlich wie das oben beschriebene.
Bei Auswahl der Beschreibung eines POST Request, bei dem mehrere Inputs erforderlich sind, führt Sie der Assistent - möglicherweise über vorbereitende Schritte - zu dem Schritt, in dem Sie die Werte der verschiedenen form-data-Teile des Multipart Request eingeben. In diesem Schritt des Assistenten wird eine Rasteransicht angezeigt, in der die Rasterzeilen jeweils einen form-data-Teil repräsentieren (siehe Abbildung unten). Nach Eingabe der Werte können Sie die Parameter des Request überprüfen und den Request anschließend senden.
In der Abbildung unten sehen Sie die Parameter eines Multipart POST Request, der auf einer OpenAPI-Beschreibung basiert. Nachdem der Request gesendet wurde, wird die Response im rechten Fenster angezeigt.
Ein gutes Beispiel für die Verwendung eines Multipart HTTP Request anhand von OpenAPI-Dateien finden Sie unter der Anleitung für die Verwendung einer OpenAPI-Datei für die Kommunikation mit der HTTP Server API von Altova RaptorXML+XBRL Server.
Nähere Informationen zum Inhaltstyp multipart/form-data im HTTP-Ausgabefenster finden Sie auch unter Senden des Request.