OpenAPI2.0 generate code snippets

Ziel

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

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
• Die Specifikation selbst ist in unserem Fall dieser Link:
• https://raw.githubusercontent.com/InterNetX/internetx-swagger-files/master/src/domainrobot.json

Installation Postman

• https://postman.com/downloads

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

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

Code Snippet in gewünschter Sprache generieren lassen

• Code kopieren und in sein Projekt einführen