La validation doit répondre à trois questions distinctes : le document est-il interprétable, le contrat est-il suffisamment sûr et documenté, et l’implémentation respecte-t-elle réellement ce contrat ?
Les quatre niveaux
| Niveau | But | Moment |
|---|---|---|
| Syntaxe | Lire YAML ou JSON | Éditeur et commit |
| Structure | Respecter la spécification | Pull request |
| Politique | Sécurité et documentation internes | Quality gate |
| Contrat réel | Comparer API et document | Tests d’intégration |
Choisir les règles bloquantes
Bloquez en priorité les références impossibles à résoudre, structures invalides, opérations sans réponse exploitable et incohérences de sécurité. Les descriptions trop courtes ou exemples manquants peuvent commencer comme avertissements, puis devenir bloquants après adoption par l’équipe.
Contrôler la compatibilité
Une spécification valide peut tout de même casser un client : suppression d’un champ, changement de type ou nouvelle valeur obligatoire. Comparez la version proposée à la version publiée et documentez la politique de rupture.
Intégrer à la CI
- Analysez le fichier à chaque demande de fusion.
- Archivez le rapport et rendez les alertes visibles dans la revue.
- Échouez seulement sur les sévérités définies par la politique.
- Exécutez ensuite les tests de contrat contre l’environnement concerné.
Rapport OpenAPI et SARIF
APICheck contrôle le standard, la sécurité et la documentation, sans appeler les serveurs déclarés.
Valider une spécificationConsultez la spécification OpenAPI officielle et la page validateur OpenAPI en ligne.
Publié le 19 juillet 2026.