OpenAPI (anciennement Swagger) est le standard de référence pour décrire les API REST dans un format lisible par les machines (YAML ou JSON). Il définit les endpoints, les paramètres, les schémas de données et les réponses attendues dans un contrat unique et vérifiable.
Documentation automatique
À partir d'un fichier OpenAPI, des outils génèrent une documentation interactive avec un bouton « Try it out » pour tester chaque endpoint en direct. On peut aussi générer automatiquement des clients SDK dans n'importe quel langage, accélérant considérablement l'intégration côté consommateur.
Validation et Qualité
L'approche contract-first permet de définir l'API avant de coder. Chaque requête et réponse est validée automatiquement contre le schéma. Avec API Platform, la spécification OpenAPI est générée nativement depuis les entités PHP, garantissant une documentation toujours à jour.
OpenAPI transforme la documentation d'API d'une corvée négligée en un véritable produit — fiable, testable et toujours synchronisé avec le code.
