Validez les spécifications OpenAPI/Swagger pour détecter les problèmes courants
OpenAPI (anciennement Swagger) est le standard pour décrire des APIs RESTful. Cette page analyse vos documents OpenAPI pour détecter des problèmes de qualité courants afin que vos contrats soient cohérents, découvrables et faciles à consommer.
Un document OpenAPI définit endpoints, méthodes, paramètres, request/response bodies, authentification et composants réutilisables en YAML ou JSON. Des spécifications claires et validées alimentent documentation, génération de code, tests et gouvernance entre équipes.
Le linter vérifie les descriptions manquantes, codes de statut ambigus, schémas incohérents et opportunités de réutilisation de composants. Il encourage un naming cohérent, des content types explicites et des exemples complets—réduisant la friction pour les SDKs et intégrations clientes.
Considérez un POST /users avec un requestBody mais sans schéma ni exemple. Le linting signale cela et suggère d’ajouter un JSON Schema sous components.schemas.User et de le référencer via $ref, puis de documenter les réponses 201 et 400 avec des payloads d’exemple.
Collez votre spec pour obtenir un retour rapide. Utilisez-le en design review et en CI pour garder des spécifications lisibles et compatibles avec les outils. Associez-le à des contract tests pour garantir l’alignement des implémentations.
Des écosystèmes API sains commencent par des specs de haute qualité. Lint tôt et régulièrement pour produire documentation et SDKs que les développeurs apprécient.