Scalar

Scalar ist eine moderne Open-Source-Entwicklererlebnisplattform, die zum Dokumentieren, Testen und Entdecken von APIs entwickelt wurde. Sie bietet eine umfassende Suite von Tools, die Standard-OpenAPI/Swagger-Dateien in erstklassige, interaktive API-Dokumentationen umwandeln. Die Plattform wird von einer Vielzahl von Nutzern, von Start-ups bis hin zu Fortune-500-Unternehmen, für ihre Leistungsfähigkeit, Flexibilität und ihren entwicklerzentrierten Ansatz geschätzt.

Im Kern generiert Scalar schöne und hochfunktionale API-Referenzen. Diese Dokumente sind nicht statisch; sie enthalten einen interaktiven Spielplatz, der es Entwicklern und Nutzern ermöglicht, API-Endpunkte direkt im Browser zu testen. Diese nahtlose Integration von Dokumentation und Testen reduziert die Einarbeitungszeit erheblich und vereinfacht den Entwicklungsworkflow. Die Plattform enthält auch einen leistungsstarken Swagger-Editor, mit dem Benutzer ihre OpenAPI-Spezifikationen einfach anzeigen, bearbeiten und verwalten können.

Wie man Scalar verwendet

Der Einstieg in Scalar ist unkompliziert. Entwickler können damit beginnen, eine vorhandene OpenAPI/Swagger-Datei zu importieren (Versionen 3.1, 3.0 und 2.0 werden unterstützt) oder eine von Grund auf mit dem integrierten Swagger-Editor zu erstellen. Sobald die Spezifikation geladen ist, generiert Scalar automatisch die interaktive Dokumentation.

Für die Integration in Projekte bietet Scalar Pakete für zahlreiche Frameworks wie .NET, Fastify, Next.js, Laravel, Express und mehr. Ein einfacher Befehl wie dotnet add package Scalar.AspNetCore ist oft alles, was benötigt wird. Von dort aus können Entwickler ein paar Zeilen Code zu ihrer Anwendung hinzufügen, um die Scalar-API-Referenzdokumentation bereitzustellen. Die Plattform bietet auch einen eigenständigen, Offline-First-API-Client, der für Web, macOS, Linux und Windows verfügbar ist und unabhängig oder in Verbindung mit der Dokumentation für robuste API-Tests verwendet werden kann.

Kernfunktionen von Scalar

• Interaktive API-Dokumentation: Generiert automatisch schöne, benutzerfreundliche API-Dokumente aus OpenAPI/Swagger-Dateien mit einem integrierten Test-Spielplatz.
• Integrierter API-Client: Ein leistungsstarker, Offline-First-REST-API-Client, der auf allen wichtigen Desktop-Plattformen für umfassende API-Tests und Debugging verfügbar ist.
• Swagger-Editor: Ein kostenloses Open-Source-Tool zum Anzeigen, Bearbeiten und Verwalten von Swagger/OAS-Dateien direkt auf der Plattform.
• Umfangreiche Anpassung: Bietet vollständige Markenanpassung mit benutzerdefinierten Themen, Farben, Typografie und der Möglichkeit, benutzerdefiniertes CSS/JavaScript hinzuzufügen, sogar im kostenlosen Plan.
• Framework-Integrationen: Bietet einfach zu bedienende Pakete für eine Vielzahl beliebter Backend-Frameworks, einschließlich .NET, Nitro, FastAPI, Hono, NestJS und mehr.
• Git + Markdown-Synchronisierung: Ermöglicht es, dass die Dokumentation neben dem Code existiert, und unterstützt in Markdown geschriebene und mit OpenAPI-Dateien verknüpfte Dokumente.
• Open-Source-Kern: Von und für die Community entwickelt, was Transparenz, kontinuierliche Verbesserung und keine Anbieterbindung gewährleistet.
• Generierung von Codebeispielen: Erstellt automatisch Codebeispiele in verschiedenen gängigen Programmiersprachen, um Benutzern die Nutzung der API zu erleichtern.

Anwendungsfälle für Scalar

Scalar ist ideal für Einzelpersonen oder Teams, die APIs erstellen, warten oder nutzen. Ein primärer Anwendungsfall sind Unternehmen, die außergewöhnliche Entwicklererlebnisse für ihre öffentlichen oder internen APIs bieten möchten. Zum Beispiel verwenden Unternehmen wie Supabase, Maersk und Tailscale Scalar, um ihre API-Dokumentation zu betreiben. Es ist auch perfekt für einzelne Entwickler, die eine schnelle und einfache Möglichkeit benötigen, eine API, an der sie arbeiten, zu visualisieren und zu testen. Teams können die Kollaborationsfunktionen im Pro-Plan nutzen, um API-Test-Arbeitsbereiche zu synchronisieren und die Konsistenz über den gesamten Entwicklungslebenszyklus sicherzustellen.

Vorteile von Scalar

Der Hauptvorteil von Scalar ist die nahtlose Integration von Dokumentation und Tests in einer einzigen, kohäsiven Plattform. Im Gegensatz zu anderen Tools, die diese Funktionen trennen, ermöglicht Scalar den Benutzern, über einen Endpunkt zu lesen und ihn sofort zu testen, ohne die Seite zu verlassen. Seine Open-Source-Natur und das Bekenntnis zur OpenAPI-Spezifikation verhindern eine Anbieterbindung. Der hohe Grad an Anpassungsmöglichkeiten ermöglicht es Unternehmen, die Markenkonsistenz zu wahren. Darüber hinaus ist sein Offline-First-API-Client ein erheblicher Vorteil für Entwickler, die ohne ständige Internetverbindung arbeiten müssen. Der großzügige kostenlose Plan macht es für jeden zugänglich, während der erschwingliche Pro-Plan leistungsstarke Funktionen für professionelle Teams bietet.

Preise und Pläne

Scalar bietet ein flexibles Freemium-Preismodell:

• Kostenloser Plan: Beinhaltet 1 Benutzer, unbegrenzte Arbeitsbereiche, kostenlose Subdomains (auf apidocumentation.com), API-Referenzen, vollständiges Styling mit Themen und benutzerdefiniertem CSS/JS sowie den integrierten Scalar-API-Client.
• Pro-Plan (12 $ pro Platz/Monat): Beinhaltet alles aus dem kostenlosen Plan sowie benutzerdefinierte Domains, Synchronisierung mit GitHub, Anleitungen & Versionen, erweiterte Suche (unterstützt von TypeSense) und priorisierten Support.
• Enterprise-Plan (Individuelle Preise): Beinhaltet alle Pro-Funktionen sowie SSO/SAML, monatliche Dokumentationsaudits, verifizierte Arbeitsbereiche und einen dedizierten Slack-Kanal für Support.