OpenAPI2.0 generate code snippets: Unterschied zwischen den Versionen

Aus xinux.net
Zur Navigation springen Zur Suche springen
Zeile 17: Zeile 17:
  
 
==Request auswählen und Parameter eintragen==
 
==Request auswählen und Parameter eintragen==
 +
#Gewünschten request heraussuchen
 +
#Parameter, Headers, Body und evtl Authorization nach bedarf anpassen
 +
#Mit '''Send''' request absetzen
 +
#Überprüfen ob response das richtige zurück gibt und alles funktioniert
 +
#'''Code''' drücken
 
[[Datei:Postman-request.png]]
 
[[Datei:Postman-request.png]]
 +
 
==Code Snippet in gewünschter Sprache generieren lassen==
 
==Code Snippet in gewünschter Sprache generieren lassen==
 
[[Datei:Postman-generated-snippet-php.png]]
 
[[Datei:Postman-generated-snippet-php.png]]

Version vom 29. Juni 2021, 12:33 Uhr

Vorbereitung

==Heraussuchen der OpenAPI Specifikation Um Code Snippets generieren lassen zu können wird zuerst die OpenAPI Specifikation des Anbieters gebraucht. Diese ist meist in der API Dokumentation zu finden. Wir werden das am Beispiel von AutoDNS durchspielen.

Die OpenAPI Specifikation für AutoDNS ist unter https://help.internetx.com/display/APIXMLEN/JSON+Technical+Documentation zu finden. Die Specifikation selbst ist in unserem Fall dieser Link: https://raw.githubusercontent.com/InterNetX/internetx-swagger-files/master/src/domainrobot.json

Installation Postman

Generien von Code snippets

Importieren der API Spezifikationen in Postmnan

  1. Import drücken
  2. Link auswählen
  3. Link einfügen
  4. Continue drücken

Postman-import-specification.png

Request auswählen und Parameter eintragen

  1. Gewünschten request heraussuchen
  2. Parameter, Headers, Body und evtl Authorization nach bedarf anpassen
  3. Mit Send request absetzen
  4. Überprüfen ob response das richtige zurück gibt und alles funktioniert
  5. Code drücken

Postman-request.png

Code Snippet in gewünschter Sprache generieren lassen

Postman-generated-snippet-php.png