Linter OpenAPI en línea — Reglas de estilo para specs

Analiza el estilo de tus specs OpenAPI 3.x (subconjunto estilo Spectral), solo en operaciones de paths y 100 % en el navegador.

Cargando…
Documentación Linter OpenAPI
Aplica un subconjunto de reglas estilo Spectral a las operaciones de paths.

Notas para desarrolladores

Subconjunto estilo Spectral personalizado — no Spectral OAS completo. Solo operaciones bajo paths (no webhooks/callbacks en v1). Reglas: not-openapi, operation-operationId, operation-tags, info-contact, info-description, paths-kebab-case, operation-success-response, operation-description. Lint en vivo con debounce; entrada Monaco JSON/YAML con autodetección. Estados: passed / passed with warnings / failed. Máximo 512 KiB. El panel Resultados muestra contadores de reglas, rutas de incidencias y estadísticas de la spec.

Casos de uso

Imponer operationId, tags y respuestas 2xx en operaciones de paths. Detectar info.contact / description faltantes antes de publicar. Preferir segmentos de ruta en kebab-case (o vN).

Ejemplos

Advertencias sin operationId

Antes

{ "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" } } } } } }

Después

operation-operationId (warning) si falta operationId

solo respuestas default = fallo

Antes

{"openapi":"3.1.0","info":{"title":"t","version":"1","description":"d","contact":{"email":"[email protected]"}},"paths":{"/x":{"get":{"operationId":"x","tags":["t"],"summary":"s","responses":{"default":{"description":"e"}}}}}}

Después

operation-success-response (error) → failed

FAQ Linter OpenAPI

Preguntas frecuentes

¿Es Spectral completo?

No. La v1 incluye un subconjunto fijo de estilo Spectral, listado en las notas para desarrolladores, y no un ejecutor de conjuntos de reglas personalizados.

¿Qué operaciones se analizan?

Solo operaciones de paths (get, put, post, delete, options, head, patch, trace). Los webhooks y callbacks quedan fuera del alcance en la v1.

¿Qué significan los resultados «passed», «passed with warnings» y «failed»?

«failed» indica al menos un error. «passed with warnings» indica solo advertencias. «passed» indica que no hay incidencias. Nunca mostramos un «válido» en verde si hay advertencias.

¿El lint hace validación de esquema?

No. El lint exige un campo openapi 3.x y un bloque info, y luego aplica las reglas de estilo. Usa Validate OpenAPI para la conformidad completa del esquema.

API y esquemas

Herramientas OpenAPI para formatear, validar y analizar tus specs.

Explorar otras categorías de herramientas