Validador de Nombres REST
Valida rutas de endpoints REST contra convenciones de nomenclatura
Acerca de Validador de Nombres REST
Revisa rutas de API, una por línea, frente a cinco reglas de nomenclatura y marca cada regla como aprobada o fallida con una etiqueta: segmentos en minúsculas, sin verbos, sustantivos en plural, sin guiones bajos y sin extensiones de archivo. Los resultados se actualizan mientras escribes, y al pasar el cursor sobre una etiqueta ves qué comprueba su regla. Sirve para auditar una lista de rutas o los paths de un spec OpenAPI antes de una revisión de diseño.
Categoría: API.
Preguntas frecuentes
¿Qué formato de entrada espera?
▾
Una ruta por línea, como /api/v1/users/{id}/orders, sin el método HTTP, el host ni la cadena de consulta. Escribe los parámetros de ruta entre llaves, porque :id o los IDs literales como 123 se tratan como nombres de recurso y fallan la regla Plural nouns.
¿Por qué evitar verbos en las URLs REST?
▾
El método HTTP (GET, POST, PUT, DELETE) ya expresa la acción. Usar verbos en la ruta como /obtenerUsuario o /eliminarPost crea redundancia y rompe la semántica REST.
¿Por qué /api/posts falla la regla No verbs?
▾
No verbs marca cualquier segmento que empiece por get, create, update, delete, fetch, add, remove, list, post, put o patch, así que sustantivos como posts, addresses o updates también fallan, mientras que los verbos fuera de esa lista, como activate, send o cualquier verbo que no esté en inglés, pasan. Plural nouns solo busca una s final, por lo que people o data fallan; toma los resultados como sugerencias.
¿Cuándo debo usar parámetros de consulta vs segmentos de ruta?
▾
Los segmentos de ruta identifican recursos (/usuarios/123). Los parámetros de consulta filtran, ordenan o paginan una colección (/usuarios?rol=admin&pagina=2). Evita usar parámetros de consulta para identificar un recurso específico.