API-Referenzen, GraphQL-Unterstützung und ein überarbeitetes Playground

API-Referenzen waren früher ausschließlich REST-basiert, und zum Durchsuchen musste man sich durch eine einfache Liste von Endpunkten blättern. Jetzt veröffentlicht Ferndesk vollständige API-Referenzen für REST und GraphQL – mit echten Seitenleistenlayouts und einem Playground, den Sie direkt testen können.

• 📘 GraphQL-Unterstützung: Veröffentlichen Sie GraphQL-APIs aus einer SDL-Datei, einem JSON-Export der Introspection oder einem Live-Endpunkt

• 🗂️ Neue API-Seitenleistenlayouts: Flat, Folders und Collapsed – mit benutzerdefinierter Gruppenreihenfolge und Symbolen

• 🚀 Ein überarbeiteter Playground: Senden Sie echte Anfragen mit „Try it“ für REST und einem vollständigen GraphQL-Playground

• 🔄 Quellen, die synchron bleiben: Laden Sie eine Spezifikation hoch, beziehen Sie sie bei jedem Push von GitHub oder verweisen Sie auf eine URL, die sich selbst aktualisiert

GraphQL-Unterstützung

GraphQL-APIs sind jetzt vollwertig integriert. Verweisen Sie Ferndesk auf eine GraphQL-SDL-Datei, einen JSON-Export der Introspection oder einen Live-Endpunkt mit aktivierter Introspection, und Sie erhalten generierte Typseiten neben Ihren Operationen.

Sie entscheiden, wie viel vom Schema Leser sehen. Die Einstellung „Show types“ fügt der Seitenleiste einen Abschnitt „Types“ hinzu, und einzelne Typen können Sie genauso ausblenden wie REST-Operationen und -Schemas.

Leser erkunden Ihr Schema im GraphQL-Playground, der auf den für die Referenz konfigurierten Endpunkt beschränkt ist. Siehe Eine API-Referenz anpassen.

Neue Seitenleistenlayouts für API-Referenzen

Wählen Sie, wie Ihre Referenz navigiert wird: Flat für eine einzelne Liste, Folders für gruppierte Endpunkte oder Collapsed, um lange Referenzen übersichtlich zu halten. Ordnen Sie Gruppen neu an, fügen Sie Symbole hinzu und blenden Sie einzelne Operationen, Schemas und Typen ein oder aus.

Bearbeitungen bleiben bei der erneuten Verarbeitung erhalten. Ersetzen oder aktualisieren Sie die Quelle, und Ihre Zusammenfassungen, Markdown-Notizen, benutzerdefinierten Codebeispiele und Layouteinstellungen bleiben bestehen.

Ein überarbeiteter Playground

Die Schaltfläche Try it öffnet den integrierten Playground von Ferndesk direkt auf der Seite der Operation. Bearbeiten Sie Parameter, Header, Cookies und den Request-Body, wählen Sie einen Server aus und senden Sie die Anfrage. Antworten werden neben der Anfrage dargestellt, und Ihr Anfrageverlauf bleibt verfügbar, während Sie die Funktionen erkunden. Siehe Den API-Referenz-Playground verwenden.

Quellen, die synchron bleiben

Laden Sie eine OpenAPI-, Swagger- oder GraphQL-Spezifikationsdatei hoch, beziehen Sie die Spezifikation aus einem GitHub-Repository oder verweisen Sie auf eine URL.

GitHub-Quellen werden automatisch erneut synchronisiert, wenn ein Push die Spezifikationsdatei ändert; standardmäßig wird dabei der Produktionsbranch Ihres Repositorys verwendet. URL-Quellen werden alle sechs Stunden automatisch aktualisiert, und Sie können beide Quellen jederzeit manuell aktualisieren. Das Einrichten einer Quelle wird unter Eine API-Referenz erstellen beschrieben; Informationen zur Pflege einer funktionierenden Quelle finden Sie unter Fehler bei API-Referenzquellen beheben.