Mathieu Desnouveaux

Tackling Open API Drift

Conférence d'Ikenna Nwaiwu sur la dérive des spécifications OpenAPI : quand la documentation ne correspond pas au comportement réel des APIs

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.

Cette sketchnote présente Tackling Open API Drift par Ikenna Nwaiwu lors des API Days Paris 2024, abordant un problème critique dans l'écosystème API : la dérive entre documentation OpenAPI et comportement réel des endpoints.

Contenu de la présentation

Le problème de l'API Drift : Ikenna définit l'API Drift comme la désynchronisation entre la documentation OpenAPI et le comportement effectif des APIs. Cette dérive se manifeste par des champs manquants dans les réponses, des schémas de requête incorrects, ou des comportements non documentés qui cassent l'expérience développeur et la fiabilité des intégrations.

Les statistiques alarmantes révèlent l'ampleur du problème : 75% des endpoints ne respectent pas leur spécification OpenAPI, tandis que 25% des endpoints n'ont tout simplement aucune documentation. Cette situation crée une dette technique massive et des intégrations fragiles dans l'écosystème API.

Les solutions stratégiques proposées par Ikenna s'articulent autour de plusieurs approches : générer la description OpenAPI directement depuis le code (approche difficile mais immédiate), générer le code depuis la description OpenAPI (solution long terme plus robuste), utiliser des tests proxy pour la validation continue, et exploiter les données et le code existants pour détecter et corriger proactivement ces dérives.

Points clés à retenir

  • Problème systémique : 75% des endpoints non-conformes, 25% sans documentation
  • Impact développeur : Champs manquants, schémas incorrects, intégrations fragiles
  • Détection proactive : Tests proxy et validation continue pour identifier les dérives
  • Approches complémentaires : Code-first et specification-first selon le contexte projet
Thèmes:
🔗 API 🏗️ Architecture
Événement:
🎤 API Days Paris
Source: Ikenna Nwaiwu
Publié le 03 décembre 2024