Scalar

Scalar ist eine Plattform zur Erstellung von API-Dokumentationen, die professionell aussehen und reibungslos funktionieren. Sie stellen Ihr OpenAPI-Dokument bereit, und Scalar verwandelt es in leicht lesbare Seiten mit integrierten Beispielen und Testwerkzeugen.

Die Plattform bietet mehrere Produkte, die zusammenarbeiten. Das API-Referenz zeigt Ihre Dokumentation in einem übersichtlichen Layout. Der API-Client ermöglicht Entwicklern, Endpunkte direkt zu testen. Die Plattform umfasst außerdem Werkzeuge zur Verwaltung mehrerer Versionen Ihrer API-Dokumente und zur Synchronisation mit GitHub.

Scalar ist vollständig Open Source, was bedeutet, dass der Code öffentlich und kostenlos nutzbar ist. Sie können es selbst hosten oder den Cloud-Service nutzen. Der kostenlose Plan deckt grundlegende Funktionen ab, während kostenpflichtige Pläne Kollaborationstools, benutzerdefinierte Domains und besseren Support bieten.

Die Verwendung von Scalar ist einfach und erfordert keine komplexe Einrichtung. Hier sind die Schritte, um loszulegen:

• Besuchen Sie die Scalar-Website und erstellen Sie ein kostenloses Konto, um Ihre Arbeit zu speichern. Sie erhalten eine kostenlose Subdomain wie yourname.apidocumentation.com.

• Laden Sie Ihr OpenAPI-Dokument hoch, indem Sie eine URL einfügen, eine Datei hochladen oder eine Verbindung zu GitHub herstellen. Scalar unterstützt sowohl JSON- als auch YAML-Formate.

• Wählen Sie ein Thema aus und passen Sie die Farben an Ihre Marke an. Sie können benutzerdefiniertes CSS hinzufügen, wenn Sie mehr Kontrolle über das Design wünschen.

• Schreiben Sie zusätzliche Anleitungen mit dem Editor. Diese Seiten erklären Konzepte, die über die automatischen Referenzseiten hinausgehen.

• Testen Sie Ihre API-Endpunkte mit dem integrierten Client. Klicken Sie auf einen Endpunkt, fügen Sie Parameter hinzu und senden Sie Anfragen, um echte Antworten zu sehen.

• Teilen Sie Ihre Dokumentation mit Ihrem Team oder machen Sie sie öffentlich. Sie können Berechtigungen festlegen, um zu steuern, wer bearbeiten oder ansehen darf.

• Schöne API-Dokumentation aus OpenAPI-Dateien

• Eingebautes Testen mit API-Client

• GitHub-Integration und automatische Synchronisierung

• Eigene Domains und Themes

• Framework-Integrationen für alle großen Plattformen

• TypeSense-gestützte Suche

• Unterstützung mehrerer API-Versionen

• Markdown- und MDX-Anleitungen

• Team-Kollaborationstools

• Open Source und selbst hostbar

• Kostenlose Subdomain inklusive

• Unterstützung für benutzerdefiniertes CSS und JavaScript