GitHub ouvre une description OpenAPI de son API REST
mer, 26/08/2020 - 11:48
Afin d'améliorer la façon dont les développeurs peuvent interagir avec son API REST, GitHub a ouvert une description OpenAPI de celle-ci.
Pour mémoire, la spécification OpenAPI (OAS) définit une description d'interface standard, indépendante du langage de programmation pour les API HTTP. Cette description d'interface permet aux humains et aux ordinateurs de découvrir et de comprendre les capacités d'un service sans avoir besoin d'accéder au code source, à une documentation supplémentaire ou à l'inspection du trafic réseau. Grâce à une telle description, un consommateur peut comprendre et interagir avec le service distant avec un minimum de logique d'implémentation.
La description GitHub OpenAPI contient plus de 600 opérations exposées par l'API REST. Pour l'exploration visuelle de l'API, vous pouvez charger la description en tant que collection Postman
Cette description est actuellement en phase bêta. Décrire une API vieille de 12 ans n'est pas une tâche facile, souligne GitHub
La description OpenAPI de l'API REST GitHub est un logiciel libre sous licence MIT, disponible sur ... GitHub :-)
