OpenAPI2.0 generate code snippets: Unterschied zwischen den Versionen

Aus Xinux Wiki
Zur Navigation springen Zur Suche springen
Zeile 8: Zeile 8:
 
*Diese ist meist in der API Dokumentation zu finden.
 
*Diese ist meist in der API Dokumentation zu finden.
 
*Wir werden das am Beispiel von AutoDNS durchspielen.
 
*Wir werden das am Beispiel von AutoDNS durchspielen.
−
 
+
*Die OpenAPI Specifikation für AutoDNS ist unter:
−
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
+
*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==
 
==Installation Postman==

Version vom 29. Juni 2021, 14:49 Uhr

Ziel

  • Wir haben eine Abfrage in einer bestimmten Form (Programmiersprache)


Vorbereitung

Heraussuchen der OpenAPI Specifikation

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

  • Code kopieren und in sein Projekt einführen

Postman-generated-snippet-php.png

Abgerufen von „http://wiki.ixheim.de/index.php?title=OpenAPI2.0_generate_code_snippets&oldid=25250“