Anweisungen: Generieren Sie API-Programmcode aus der OpenAPI-Dokumentation.

0

Zugegebenermaßen wird eine OpenAPI-Dokumentation nicht wie von Zauberhand zu einer fertigen API und ein Code-Generator macht Entwickler nicht überflüssig.

Allerdings kann Ihnen ein solcher Generator eine Menge Arbeit abnehmen.

Der klassische Weg ist, zuerst den Code zu schreiben und dann das Problem der Dokumentation der fertigen API zu überwinden.

Dieser Ansatz wird “Code First” genannt und eignet sich, wenn jemand erst nach Fertigstellung um die Dokumentation bittet.

Der am häufigsten verwendete Standard für die API-Dokumentation von REST-APIs heißt OpenAPI, die Dokumentation ist im YAML-Format geschrieben.

Für den “Code First”-Ansatz gibt es eine gewisse Unterstützung durch Generatoren.

Dann werden relevante Funktionen im Code mit Kommentarblöcken versehen und ein Parser macht daraus eine OAS-Dokumentation.

API zuerst

Sie können den OpenAPI-Standard verwenden, um automatisch Code aus der Dokumentation zu generieren, zum Beispiel für das PHP-Framework Laravel.

Nicht direkt mit der Programmierung zu beginnen, sondern die API zunächst in einer YAML-Datei zu dokumentieren, klingt für viele Menschen furchtbar kompliziert und ungewohnt.

Aber dieser Ansatz bietet viele Vorteile: Wer in größeren Teams oder Unternehmen arbeitet, kommt nicht umhin, mit dem Kunden und den Kollegen genau abzustimmen, wie die API aufgebaut werden soll.

Eine OpenAPI-Beschreibung bietet eine neutrale, programmiersprachenunabhängige und vergleichsweise leicht lesbare Möglichkeit.

Der umgekehrte Ansatz, d.h. “API First”, ist ebenfalls populär geworden.

Ohne auch nur eine Zeile Code zu schreiben, werden die Anforderungen an die API in einer OAS-Beschreibung festgehalten.

..

Share.

Leave A Reply