Linter OpenAPI en ligne — Règles de style pour specs

Analysez le style de vos specs OpenAPI 3.x (sous-ensemble Spectral) — opérations paths uniquement, 100 % navigateur.

Chargement…
Documentation Linter OpenAPI
Appliquez un sous-ensemble de règles style Spectral aux opérations paths.

Notes développeur

Sous-ensemble style Spectral — pas Spectral OAS complet. Opérations sous paths uniquement (pas webhooks/callbacks en v1). Règles : not-openapi, operation-operationId, operation-tags, info-contact, info-description, paths-kebab-case, operation-success-response, operation-description. Lint live debounced ; entrée Monaco JSON/YAML auto-détectée. Statuts : passed / passed with warnings / failed. Limite 512 Kio. Le panneau Résultats affiche compteurs, chemins et stats spec.

Cas d’usage

Imposer operationId, tags et réponses 2xx sur les opérations paths. Repérer info.contact / description manquants avant publication. Préférer les segments de chemin en kebab-case (ou vN).

Exemples

Avertissements sans operationId

Avant

{ "openapi": "3.1.0", "info": { "title": "Pets", "version": "1.0.0" }, "paths": { "/pets": { "get": { "operationId": "listPets", "tags": ["pets"], "summary": "List pets", "responses": { "200": { "description": "OK" } } } } } }

Après

operation-operationId (avertissement) si operationId manquant

réponses default seules = échec

Avant

{"openapi":"3.1.0",…,"responses":{"default":{"description":"e"}}}

Après

operation-success-response (erreur) → failed

FAQ Linter OpenAPI

Questions fréquentes

Est-ce Spectral complet ?

Non. La v1 livre un sous-ensemble fixe listé dans les notes développeur — pas d’exécution de ruleset personnalisé.

Quelles opérations sont analysées ?

Uniquement les opérations paths (get/put/post/delete/options/head/patch/trace). webhooks et callbacks hors scope v1.

Que signifient passed / warnings / failed ?

failed = au moins une erreur ; passed with warnings = avertissements seulement ; passed = aucun problème. Jamais de vert « valide » s’il y a des warnings.

Le lint fait-il la validation schéma ?

Non. Le lint exige openapi 3.x + info, puis les règles de style. Utilisez Valider OpenAPI pour la conformité schéma.

API & schémas

Outils OpenAPI pour formater, valider et analyser vos specs.

Découvrez les autres catégories d'outils