REST-APIs dokumentieren nach dem OpenAPI-Standard
Damit andere bequem mit einem API arbeiten können, braucht es eine gute Dokumentation. Den Standard OpenAPI können Maschinen und Menschen lesen.
(Bild: Thorsten Hübner)
- Manuel Ottlik
Programmierschnittstellen nach dem REST-Schema (Representational State Transfer), die per HTTP(S) bereitgestellt werden, machen Entwicklern das Leben leicht. Schnell bekommt man zum Beispiel Wetterdaten, Verkehrsinformationen oder Börsendaten für die eigene Anwendung. Die strukturierten Daten sind leicht zu verarbeiten, wenn man denn ihre Struktur kennt. Damit die Entwicklung zügig vorangeht, braucht man eine Dokumentation, aus der hervorgeht, wie die Endpunkte heißen und welche Daten es dort zu holen gibt.
Ohne Erklärung weiß schließlich kein Entwickler, ob der Endpunkt für das Wetter-API /weather oder /data heißt oder welche Parameter die Abfrage des Endpunkts erwartet. Als Betreiber eines APIs könnte man die Dokumentation als Fließtext in einer Readme-Datei zusammentragen und allen Nutzern zukommen lassen. Die müssten sich dann aber immer noch durch viel Text arbeiten.
Sinnvoller ist es, das Format der strukturierten Daten selbst in eine strukturierte Schnittstellendefinition zu verpacken. Hält man sich dann noch an einen Standard, kann man davon ausgehen, dass andere Entwickler schnell mit dem API arbeiten können.
Immer mehr Wissen. Das digitale Abo für IT und Technik.
Proxmox VE: Was es kann und was man dafür braucht
Elektroauto Mercedes EQA 300 4Matic im Test: Fährt gut, lädt gemächlich
Fremdsprachen lernen: Wie man ChatGPT zum Sprechtrainer aufrüstet
High-End-Smartphones im Kameravergleich: Wettkampf um die beste Bildqualität
Eigene Domain für zu Hause: Reverse-Proxy auf dem Raspberry Pi einrichten
Custom-ROM "GrapheneOS" vorgestellt: Android ganz privat
Immer mehr Wissen. Das digitale Abo für IT und Technik.
Proxmox VE: Was es kann und was man dafür braucht
Elektroauto Mercedes EQA 300 4Matic im Test: Fährt gut, lädt gemächlich
Fremdsprachen lernen: Wie man ChatGPT zum Sprechtrainer aufrüstet
High-End-Smartphones im Kameravergleich: Wettkampf um die beste Bildqualität
Eigene Domain für zu Hause: Reverse-Proxy auf dem Raspberry Pi einrichten