Document360 v12.8.1 est désormais en ligne, et il transforme la manière dont les développeurs travaillent avec la documentation de votre API. La référence API est désormais un espace pour explorer, tester et dépanner les points de terminaison sans jamais quitter la page, avec une console Try It ! reconstruite, une validation de schéma en direct, une autorisation en console et une IA Eddy répondant aux questions en ligne. Parallèlement, une nouvelle architecture d’intégration Widget 2.0 commence à être déployée, accompagnée de mises à jour de sécurité, d’améliorations de performance et d’améliorations de l’interface utilisateur sur le portail et le site de la base de connaissances.
Fonctionnalités et améliorations
Une expérience de référence API puissante et interactive
Catégorie : Documentation API | Caractéristiques
La référence API a subi une refonte majeure dans cette version, offrant aux développeurs qui lisent votre documentation un moyen plus rapide et plus performant d’explorer et de tester vos API. Il utilise désormais une mise en page repensée à trois volets, et une console Try It ! reconstruite permet aux lecteurs de créer des requêtes avec un contrôle total sur les paramètres, les en-têtes et le corps, puis de voir la réponse en direct directement sur la page. L’éditeur de requêtes valide les charges utiles contre le schéma du point de terminaison au fur et à mesure que vous tapez, détectant les erreurs avant leur envoi ; les variables réutilisables au niveau de la session permettent d’enregistrer une valeur une fois et d’être utilisées entre les points de terminaison ; et les lecteurs peuvent autoriser les points de terminaison sécurisés directement dans la console. Eddy AI est aussi intégré, permettant aux lecteurs de poser des questions et d’obtenir du contexte sur un point de départ sans quitter la référence.
La nouvelle expérience est actuellement disponible sur les projets nouvellement créés et est déployée aux clients existants en plusieurs phases. Vous pouvez essayer la nouvelle expérience dans notre propre documentation API Document360 à apidocs.document360.com.
Pour plus d’informations, lisez l’article sur le test des points de terminaison avec Try It !
Autres mises à jour
- Une nouvelle architecture d’intégration Widget 2.0 est en cours de déploiement avec une option de test et de migration. Vous aurez reçu un e-mail avec les modifications techniques requises et le calendrier pour les réaliser.
- Des mises à jour mineures de sécurité, corrections de bugs, améliorations de performance et améliorations de l’interface utilisateur ont également été mises en œuvre sur le portail de la base de connaissances et le site de la base de connaissances.