Mathieu Desnouveaux

Tackling Open API Drift

#API Days Paris 2024
La sketchnote de la conférence de Ikenna Nwaiwu traite du problème de la dérive des spécifications OpenAPI. En haut à gauche, le titre "API Days Paris 2024" est affiché en lettres blanches sur fond rouge. Le titre de la conférence, "Tackling Open API Drift", est écrit en lettres orange et noires sur fond blanc. La sketchnote est structurée autour de plusieurs blocs et annotations : 1. Dérive des Spécifications OpenAPI : La dérive survient lorsque la documentation OpenAPI ne correspond pas au comportement des API, entraînant des erreurs comme des champs manquants ou des schémas incorrects. 2. Statistiques : * 75 % des endpoints ne sont pas conformes à la spécification OpenAPI. * 25 % des endpoints n'ont pas de documentation. 3. Solutions Proposées : * Générer une description OpenAPI à partir du code, une tâche difficile. * Générer du code à partir de la description OpenAPI, une solution à long terme. * Utiliser des tests proxy pour la validation. * Utiliser les données et le code existants pour lutter contre la dérive des spécifications OpenAPI. Des flèches et des annotations relient ces concepts pour montrer les relations et les solutions proposées.

Lors de la conférence "Tackling Open API Drift" des "API Days Paris 2024", Ikenna Nwaiwu a expliqué le problème de la dérive des spécifications OpenAPI, où la documentation ne correspond pas au comportement réel des API. Cela entraîne des erreurs telles que des champs manquants ou des schémas incorrects. Nwaiwu a souligné que 75 % des endpoints ne sont pas conformes à la spécification OpenAPI et que 25 % n'ont pas de documentation. Pour résoudre ce problème, il a proposé de générer des descriptions OpenAPI à partir du code, de générer du code à partir des descriptions OpenAPI, et d'utiliser des tests proxy pour la validation. Il a conclu en recommandant d'utiliser les données et le code existants pour lutter contre cette dérive.