Références d’API, prise en charge de GraphQL et playground repensé

Les références d’API étaient auparavant limitées à REST, et en consulter une revenait à parcourir une simple liste de points de terminaison. Désormais, Ferndesk publie des références d’API complètes pour REST et GraphQL, avec de véritables mises en page de barre latérale et un playground que vous pouvez réellement tester directement.

• 📘 Prise en charge de GraphQL : publiez des API GraphQL à partir d’un fichier SDL, d’une exportation JSON d’introspection ou d’un point de terminaison actif

• 🗂️ Nouvelles mises en page de la barre latérale des API : Plate, Dossiers et Réduite, avec un ordre personnalisé des groupes et des icônes

• 🚀 Un playground repensé : envoyez de vraies requêtes avec Essayer pour REST et un playground GraphQL complet

• 🔄 Des sources qui restent synchronisées : importez une spécification, récupérez-la depuis GitHub à chaque push ou indiquez une URL qui s’actualise automatiquement

Prise en charge de GraphQL

Les API GraphQL sont désormais prises en charge au même titre que les autres. Indiquez à Ferndesk un fichier SDL GraphQL, une exportation JSON d’introspection ou un point de terminaison actif avec l’introspection activée, et vous obtiendrez des pages de types générées en complément de vos opérations.

Vous décidez de la quantité du schéma visible par les lecteurs. Le paramètre Afficher les types ajoute une section Types à la barre latérale, et vous pouvez masquer des types individuels de la même manière que vous masquez des opérations et des schémas REST.

Les lecteurs explorent votre schéma dans le playground GraphQL, qui est limité au point de terminaison que vous configurez pour la référence. Consultez Personnaliser une référence d’API.

Nouvelles mises en page de la barre latérale des références d’API

Choisissez la navigation de votre référence : Plate pour une liste unique, Dossiers pour des points de terminaison regroupés ou Réduite pour garder les références longues bien organisées. Réorganisez les groupes, ajoutez des icônes et affichez ou masquez des opérations, des schémas et des types individuels.

Les modifications sont conservées lors du retraitement. Remplacez ou actualisez la source : vos résumés, notes Markdown, exemples de code personnalisés et choix de mise en page restent en place.

Un playground repensé

Le bouton Essayez ouvre le playground intégré de Ferndesk directement sur la page de l’opération. Modifiez les paramètres, les en-têtes, les cookies et le corps de la requête, choisissez un serveur, puis envoyez la requête. Les réponses s’affichent à côté de la requête, et l’historique de vos requêtes reste disponible pendant votre exploration. Consultez Utiliser le playground de la référence d’API.

Des sources qui restent synchronisées

Importez un fichier de spécification OpenAPI, Swagger ou GraphQL, récupérez la spécification depuis un dépôt GitHub ou indiquez une URL.

Les sources GitHub se resynchronisent automatiquement lorsqu’un push modifie le fichier de spécification, en utilisant par défaut la branche de production de votre dépôt. Les sources URL s’actualisent automatiquement toutes les six heures, et vous pouvez actualiser l’une ou l’autre manuellement quand vous le souhaitez. La configuration d’une source est expliquée dans Créer une référence d’API, et la résolution des problèmes d’une source dans Corriger les erreurs de source d’une référence d’API.