Cloudflare hat Forge vorgestellt, eine erweiterbare Open-Source-Pipeline zur Generierung von SDK-Paketen, Kommandozeilen-Tools, Dokumentation und Bibliotheken direkt aus API-Definitionen. Forge läuft in Continuous-Integration-Umgebungen (CI) und kann kostenlos sowie selbstverwaltet betrieben werden, anstatt von einem gehosteten SaaS-Dienst abhängig zu sein.
Das Projekt ist eine Reaktion auf Cloudflares Bedarf, eine API mit mehr als 3.500 Operationen zu verwalten, die von Hunderten Diensten unterstützt wird, welche in Sprachen wie Rust, Go, TypeScript und Python geschrieben sind. Nach Angaben des Unternehmens generiert Forge derzeit die erforderlichen Ausgaben für das cf CLI-Tool; in den kommenden Monaten soll die Nutzung auf die Cloudflare-Dokumentation, SDK-Pakete und weitere Bereiche ausgeweitet werden.
Vorschauen für jede Änderung
Forge läuft innerhalb der Repositories der Produktteams. Dabei prüft es jede Änderung und erstellt Vorschauversionen des CLI-Tools, der Dokumentation und der SDK-Pakete, wobei die daraus resultierenden Anpassungen hervorgehoben werden. Die Teams können diese Versionen installieren und testen, bevor sie eine API-Änderung zusammenführen oder für Kunden bereitstellen.
Dieser Mechanismus zielt auf ein praktisches Problem in Umgebungen ab, in denen die API auf Hunderte von Diensten und Repositories verteilt ist: Eine einzelne Änderung kann die Generierung beeinträchtigen, und das betroffene Team entdeckt das Problem möglicherweise erst bei der Veröffentlichung. Wird die Generierung dagegen frühzeitig innerhalb von CI ausgeführt, verlagert sich die Überprüfung in eine Phase, die näher an der Quelle der Änderung liegt, und der erforderliche Abstimmungsaufwand zwischen den Teams sinkt.
Generierung miteinander verknüpfter Ausgaben
Forge beschränkt sich nicht auf herkömmliche Sprachziele. Das Projekt kann eine OpenAPI-Definition übernehmen und Ausgaben wie Cap’n Web generieren, ein RPC-System von Cloudflare, das den Aufruf entfernter TypeScript-Schnittstellen auf eine Weise ermöglicht, die dem Aufruf lokaler Funktionen ähnelt. Das Unternehmen verweist außerdem auf die Möglichkeit, denselben Ansatz zur Erstellung von TanStack-Query-Bindings, Zod- oder Valibot-Schemas sowie MCP-Servern zu verwenden.
Forge basiert auf verkettbaren Adaptern, sodass eine Ausgabe zur Erzeugung einer weiteren Ausgabe verwendet werden kann. OpenAPI wird derzeit als Eingabetyp unterstützt; das Design ermöglicht künftig die Ergänzung von AsyncAPI, GraphQL, Cap’n Proto und Protobuf. Nutzer können außerdem die Generierungskette festlegen, anstatt auf einen festen Ablauf beschränkt zu sein. Dies ist wichtig, wenn ein CLI-Tool in einer anderen Sprache als ein SDK-Paket erstellt wird oder wenn das Tool manuell geschriebene Befehle enthält.
Was ändert sich in der Praxis?
Forge bietet ein Modell, bei dem Tools für den API-Konsum Teil des Entwicklungszyklus der Schnittstelle selbst werden und nicht getrennte Produkte sind, die später aktualisiert werden. Dies hilft Teams, die SDK, Dokumentation und CLI synchron halten müssen. Es macht jedoch weiterhin eine Überprüfung der generierten Ausgaben erforderlich, insbesondere wenn das Tool generierten Code mit manuell geschriebenen Befehlen oder Verhaltensweisen kombiniert.
Cloudflare verknüpft das Projekt außerdem mit seinen Plänen für die Verwaltung von API-Versionen. Nach einem Jahrzehnt der Nutzung der Hauptversion v4 erklärt das Unternehmen, an einem Ansatz zu arbeiten, der die Veröffentlichung neuer Hauptversionen ermöglicht, ohne Kunden oder ältere SDK-Pakete zu beeinträchtigen. In dem Beitrag wurden weder Einzelheiten zu diesem Ansatz noch ein Zeitplan für seine Umsetzung bekannt gegeben.
Offene Lizenz und Grenzen der aktuellen Phase
Forge ist nun unter der Apache-2.0-Lizenz verfügbar und kann kostenlos ausgeführt, geändert sowie intern oder privat genutzt werden. Cloudflare beschreibt das Projekt trotz seiner Verwendung zur Generierung von cf-CLI-Ausgaben als noch in einer frühen Phase befindlich. Zugleich kündigte das Unternehmen spätere Einzelheiten zu den SDKs für TypeScript, Rust, Python, Go und PHP sowie Terraform an, mit besonderem Hinweis auf die Migrationsanforderungen beim Terraform-Provider.