Anleitung: API-Programmcode aus der OpenAPI-Dokumentation generieren
Den Standard OpenAPI können Sie nutzen, um automatisch Code aus Dokumentationen zu erzeugen, etwa für das PHP-Framework Laravel.
(Bild: Thorsten Hübner)
- Manuel Ottlik
Zugegeben, komplett von Zauberhand wird aus einer OpenAPI-Dokumentation kein fertiges API und ein Code-Generator macht Entwickler auch nicht überflüssig. Ein solcher Generator kann Ihnen aber eine Menge Fleißarbeit abnehmen. Ganz klassisch schreibt man erst den Code und überwindet sich dann, das fertige API zu dokumentieren. Die Herangehensweise nennt man "Code First" und sie eignet sich dann, wenn erst nach Fertigstellung jemand nach der Dokumentation fragt. Der meistgenutzte Standard für API-Dokumentationen von REST-APIs heißt OpenAPI, formuliert wird die Doku im YAML-Format. Für den Ansatz "Code First" gibt es einige Unterstützung durch Generatoren. Dann werden relevante Funktionen im Code mit Kommentarblöcken versehen und ein Parser macht daraus eine OAS-Dokumentation.
API First
Populär geworden ist aber auch das gegensätzliche Vorgehen, also "API First". Ohne dass auch nur eine Zeile Code geschrieben ist, werden die Anforderungen an das API in einer OAS-Beschreibung festgehalten.
Nicht direkt mit dem Programmieren anzufangen, sondern erst das API in einer YAML-Datei zu dokumentieren, klingt für viele schrecklich umständlich und ungewohnt. Der Ansatz bietet aber viele Vorteile: Wer in größeren Teams oder Unternehmen arbeitet, wird nicht umhinkommen, sich mit dem Auftraggeber und Kollegen abzustimmen, wie das API genau gebaut werden soll. Eine OpenAPI-Beschreibung bietet da eine neutrale, programmiersprachenunabhängige und vergleichsweise leicht zu lesende Möglichkeit.
Immer mehr Wissen. Das digitale Abo für IT und Technik.
Papierloses Büro: Wie man mit paperless-ngx die Dokumentenverwaltung optimiert
Know-how für Heim-Admins: Alles über Ethernet-Switches
Günstigerer Strom für die Wärmepumpe: Was Sie jetzt wissen müssen
Fremdsprachen lernen: Wie man ChatGPT zum Sprechtrainer aufrüstet
Künstliche Intelligenz: Die Mathematik hinter neuronalen Netzen
Trend-Beruf: Mit diesen Fähigkeiten wird man KI-Experte
Immer mehr Wissen. Das digitale Abo für IT und Technik.
Papierloses Büro: Wie man mit paperless-ngx die Dokumentenverwaltung optimiert
Know-how für Heim-Admins: Alles über Ethernet-Switches
Günstigerer Strom für die Wärmepumpe: Was Sie jetzt wissen müssen
Fremdsprachen lernen: Wie man ChatGPT zum Sprechtrainer aufrüstet
Künstliche Intelligenz: Die Mathematik hinter neuronalen Netzen