Introduction#
J’ai récemment découvert un outil formidable pour tous les développeurs qui travaillent avec des API : ‘oq’. Cette visionneuse basée sur le terminal nous permet de consulter et de naviguer dans la documentation API sans quitter notre terminal.
Résumé#
Ce qui rend ‘oq’ intéressant, c’est sa capacité à supporter à la fois les versions OpenAPI 3.0.x et 3.1.x, que ce soit en JSON ou en YAML. Son interface interactive facilite la navigation parmi les chemins d’accès et les composants d’une API.
Utilité pros tech#
En utilisant oq, je peux désormais accéder aux spécifications des API depuis des fichiers, stdin ou même des URLs directement. Cela me permet de rester concentré sur mes tâches sans avoir besoin de changer constamment de fenêtre.
Mon expérience#
J’ai essayé d’importer plusieurs spécifications API et la navigation clavier m’a permis de rapidement explorer les structures des API. C’est convivial pour tout développeur qui cherche à maximiser son efficacité.
Conclusion#
Ce qui me plaît dans cette catégorie d’outils, c’est qu’ils prennent au sérieux le fait que la spécification est un artefact de travail, consulté plusieurs fois par jour, et pas une documentation que l’on ouvre une fois par trimestre. Rester dans le terminal évite la rupture de contexte du passage au navigateur, et rend la consultation possible depuis une session SSH, là où une interface web n’est tout simplement pas disponible.
L’intégration d’un tel outil dans mon flux de travail a simplifié l’exploration des API. ‘oq’ est définitivement un ajout précieux à la boîte à outils de développement. Découvrez l’article complet ici : Lire l’article.