Formation Conception d’API avec OpenAPI & Swagger

Programme de notre formation Conception d’API avec OpenAPI & Swagger

[Jour 1 – Matin]

Fondamentaux du design d'API et d'OpenAPI

• Positionnement de l’approche API-first et rôle du contrat d’API dans le cycle de développement
• Principes de conception d’une API REST : ressources, URI, verbes HTTP et codes de statut
• Découverte de la structure d’un document OpenAPI 3.x en YAML ou en JSON
• Description des métadonnées, des serveurs, des tags et des chemins avec info, servers et paths
• Conventions de nommage, granularité des ressources et cohérence des opérations
• Atelier pratique : créer dans Swagger Editor le contrat initial d’une API de gestion de catalogue

[Jour 1 – Après-midi]

Modélisation des opérations et des données

• Définition des opérations GET, POST, PUT, PATCH et DELETE
• Gestion des paramètres de chemin, de requête, d’en-tête et des corps de requête
• Conception des réponses : médias, en-têtes, exemples et codes de statut HTTP
• Modélisation des objets avec Schema Object, types, formats, contraintes et énumérations
• Factorisation des modèles avec components et réutilisation via $ref
• Atelier pratique : modéliser les opérations CRUD, les schémas et les réponses de l’API catalogue

[Jour 2 – Matin]

Qualité, documentation et sécurité des contrats

• Conception de réponses d’erreur homogènes et description des cas fonctionnels
• Utilisation des exemples pour rendre un contrat d’API compréhensible et testable
• Documentation interactive et exploration des endpoints avec Swagger UI
• Présentation des mécanismes de sécurité : API Key, HTTP Bearer et OAuth 2.0
• Validation syntaxique, relecture de contrat et détection des incohérences avec Swagger Editor
• Atelier pratique : ajouter les erreurs, les exemples et une authentification Bearer à la spécification

[Jour 2 – Après-midi]

Industrialisation et gouvernance d'une API

• Stratégies de versioning, compatibilité ascendante et dépréciation des opérations
• Organisation d’une spécification volumineuse : découpage, composants partagés et conventions d’équipe
• Exploitation du contrat pour la génération de documentation, de clients et de squelettes de services
• Place d’OpenAPI dans les tests, les mocks, l’intégration continue et la collaboration métier technique
• Checklist de publication : lisibilité, sécurité, complétude, cohérence et maintenabilité
• Atelier pratique : finaliser, valider et présenter une spécification OpenAPI prête à être partagée