OpenAPI Comment Parser : un outil IBM pour analyser les commentaires dans le code d'une API et générer la documentation correspondante
ven, 02/10/2020 - 16:43
Les développeurs ont besoin d'instructions sur la façon d'utiliser une API et ils ont besoin d'un moyen de l'essayer. Une bonne documentation satisfait ces deux besoins. Pour aider à générer une telle documentation, conforme aux spécifications OpenAPI, IBM propose OpenAPI Comment Parser
OpenAPI Comment Parser a pour objectif de donner aux développeurs d'API un moyen de générer une documentation conforme aux spécifications OpenAPI à partir de commentaires en ligne dans leur code. Lorsque la spécification OpenAPI vit dans le code, les développeurs sont beaucoup plus susceptibles de la maintenir à jour à mesure que leur code change, souligne IBM.
OpenAPI Comment Parser est une bibliothèque est conçue pour Node.js, mais elle peut fonctionner avec n'importe quel langage qui utilise ce style de commentaires:
/**
* GET /users/{userId}
* @summary Returns a user by ID.
* @pathParam {int64} userId - The user's ID.
* @response 200 - OK
*/
OpenAPI Comment Parser est un logiciel libre sous licence Apache 2.0, disponivle sur GitHub.
