Références API, prise en charge de GraphQL et nouvelle version du playground
Auparavant, les références API étaient uniquement compatibles avec REST, et pour en consulter une, il fallait parcourir une simple liste de points de terminaison. Désormais, Ferndesk publie des références API complètes pour REST et GraphQL, avec de véritables barres latérales et un playground que vous pouvez réellement tester.
📘 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 en direct
🗂️ Nouvelles dispositions de la barre latérale des API : à plat, avec dossiers ou réduite, avec un ordre de groupes et des icônes personnalisés
🚀 Un playground repensé : envoyez de vraies requêtes avec « Essayer » pour REST et un playground GraphQL complet
🔄 Des sources toujours 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 à part entière. Indiquez à Ferndesk un fichier SDL GraphQL, une exportation JSON d’introspection ou un point de terminaison en direct avec l’introspection activée, et des pages de types sont générées en plus de vos opérations.
C’est vous qui décidez de la partie du schéma visible par les lecteurs. Le paramètre « Afficher les types » ajoute une section « Types » à la barre latérale. Vous pouvez également masquer des types individuellement, comme vous le faites pour les opérations et les 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 Publier une référence API.
Nouvelles dispositions de la barre latérale des références API
Choisissez la navigation de votre référence : à plat pour une seule liste, avec des dossiers pour regrouper les points de terminaison 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 les opérations, les schémas et les types individuellement.
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 Essayer 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 et 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 Publier une référence API.
Des sources toujours 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 Publier une référence API, et son maintien en bon état dans Publier une référence API.
La création, le remplacement et la publication de références API nécessitent un abonnement actif ou en période d’essai.