OpenAPI2.0 generate code snippets
Zur Navigation springen
Zur Suche springen
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
Generien von Code snippets
Importieren der API Spezifikationen in Postmnan
- Import drücken
- Link auswählen
- Link einfügen
- Continue drücken
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
Code Snippet in gewünschter Sprache generieren lassen
- Code kopieren und in sein Projekt einführen
