Fern

Fern ist eine Plattform, die automatisch SDKs und API-Dokumentationen aus Ihrer API-Definition generiert. Sie stellen Ihre OpenAPI-, AsyncAPI- oder gRPC-Spezifikation bereit, und Fern erstellt gebrauchsfertige Client-Bibliotheken in Sprachen wie TypeScript, Python, Go, Java, Ruby, C#, PHP und Swift.

Die Plattform erstellt außerdem Dokumentationswebsites, die professionell aussehen und Ihre Markenidentität widerspiegeln. Diese Seiten enthalten interaktive API-Referenzen, Codebeispiele und einen Playground, in dem Entwickler Ihre API testen können, ohne die Dokumentation zu verlassen.

Fern ist Open Source und auf GitHub verfügbar. Es integriert sich in Ihren bestehenden Workflow, indem SDKs direkt in Paket-Registries wie npm und PyPI veröffentlicht werden. Das Tool ist für Unternehmen konzipiert, die ein großartiges Entwicklererlebnis bieten möchten, ohne Engineering-Ressourcen für die manuelle Pflege von SDKs aufzuwenden.

Der Einstieg mit Fern ist unkompliziert. So verwenden Sie es:

• Installieren Sie die Fern-CLI mit npm, indem Sie den Installationsbefehl in Ihrem Terminal ausführen. Sie benötigen Node.js Version 18 oder höher.

• Initialisieren Sie ein Fern-Projekt, indem Sie den init-Befehl mit Ihrer OpenAPI-Spezifikation ausführen. Sie können eine lokale Datei verwenden oder eine URL zu Ihrer API-Spezifikation angeben.

• Konfigurieren Sie in der Generators-Datei, welche Ausgaben Sie wünschen. Sie können SDKs in mehreren Sprachen generieren, Dokumentationen erstellen oder beides.

• Führen Sie den generate-Befehl aus, um Ihre SDKs und Dokumentationen zu erstellen. Fern verarbeitet Ihre API-Definition und erzeugt die gewünschten Artefakte.

• Passen Sie Ihre Dokumentation an, indem Sie Markdown-Seiten hinzufügen, Farben und Schriftarten anpassen und Ihre eigene Domain einrichten.

• Richten Sie die automatische Veröffentlichung ein, damit Fern Ihre SDKs an Paket-Registries senden und Ihre Dokumentationsseite aktualisieren kann, sobald Sie API-Änderungen vornehmen.

• Automatische SDK-Generierung in über 8 Programmiersprachen

• API-Dokumentationswebsites im Stripe-Stil

• Direkte Veröffentlichung in Paket-Registries

• Unterstützung für OpenAPI und AsyncAPI

• Interaktiver API-Spielplatz mit Live-Tests

• Unterstützung für individuelles Branding und eigene Domains

• Eingebaute OAuth 2.0- und Authentifizierung

• Automatische Paginierung und Wiederholungslogik

• Unterstützung für WebSocket und SSE

• Versionskontrolle mit Git

• KI-gestützter Suchassistent

• Open Source auf GitHub