Redocly

Redocly ist eine API-Dokumentationsplattform, die Ihnen hilft, professionelle Entwicklerportale zu erstellen. Sie beginnen mit einer OpenAPI-Datei, die Ihre API beschreibt, und Redocly verwandelt diese in eine saubere, lesbare Dokumentation mit Beispielen und interaktiven Funktionen.

Die Plattform umfasst mehrere Produkte, die zusammenarbeiten. Reunite ist der Ort, an dem Teams Inhalte schreiben und überprüfen. Realm liefert die endgültige Dokumentation an Ihre Nutzer. Redoc ist die Open-Source-Engine, die API-Referenzdokumente rendert. Reef hilft Ihnen, alle Ihre APIs in einem Katalog zu organisieren und zu entdecken.

Im Gegensatz zu einfachen Dokumentationsgeneratoren bietet Redocly Ihnen ein vollständiges Entwicklerportal. Sie können Leitfäden, Tutorials und benutzerdefinierte Seiten neben Ihrer API-Referenz hinzufügen. Alles ist versioniert und wird automatisch aktualisiert, wenn Sie Ihre API-Definition ändern.

Der Einstieg mit Redocly ist unkompliziert. Hier sind die Schritte zur Erstellung Ihrer Dokumentation:

• Melden Sie sich für ein Redocly-Konto an und starten Sie Ihre kostenlose Testphase auf deren Website.

• Verbinden Sie Ihr Code-Repository von GitHub, GitLab oder Azure DevOps, um Ihre OpenAPI-Dateien automatisch zu synchronisieren.

• Laden Sie Ihre OpenAPI-Definitionsdatei hoch oder verlinken Sie sie. Redocly unterstützt OpenAPI-Versionen 2.0, 3.0 und 3.1.

• Passen Sie das Erscheinungsbild an, indem Sie Farben, Schriftarten ändern und Ihr Logo hinzufügen, um Ihre Marke widerzuspiegeln.

• Fügen Sie zusätzliche Inhaltsseiten mit Markdown für Anleitungen, Tutorials und Einstiegshilfen hinzu.

• Verwenden Sie den integrierten Editor, um Änderungen zu schreiben und vor der Veröffentlichung an Ihr Publikum zu überprüfen.

• Richten Sie automatische Builds ein, sodass die Dokumentation bei jeder Änderung Ihrer API-Definition im Repository aktualisiert wird.

• Konfigurieren Sie Ihre eigene Domain, um die Dokumentation unter Ihrer eigenen Website-Adresse zu hosten.

• Automatische API-Dokumentation aus OpenAPI-Dateien

• Schönes Drei-Spalten-Layout mit Navigation und Beispielen

• Interaktive API-Konsole zum Testen von Endpunkten

• Optionen für individuelles Branding und Styling

• Git-Workflow mit automatischen Updates

• Unterstützung für mehrere API-Versionen

• Erweiterte Suche mit KI-Funktionen

• Markdown-Unterstützung für Anleitungen und Tutorials

• Teamzusammenarbeit und Überprüfungstools

• Inklusive Hosting auf benutzerdefinierter Domain