api-validator

REST API validation checks versioning, resource naming, HTTP methods, status codes, pagination, and Swagger documentation compliance. Run the validator against your project to identify deviations from standards like /v1/ prefixes, plural lowercase resource names, and correct method-status mappings, catching issues before deployment.

Enforce plural nouns, lowercase-with-hyphens format, and exclude verbs from resource names. The validator checks that your endpoints follow these conventions consistently, ensuring predictable, readable API contracts across your microservices and monoliths.

Yes. The validator verifies full OpenAPI documentation coverage for all endpoints, ensuring every route has complete Swagger specs. This catches undocumented endpoints during design reviews and pre-deployment audits.

The validator checks that endpoints use correct HTTP methods with matching status codes—for example, POST returns 201, GET returns 200, DELETE returns 204. This prevents common contract violations and improves API predictability.

Pagination DTOs structure large responses, improving performance and usability. The validator requires list endpoints to support pagination and structured responses, preventing unbounded result sets and ensuring scalable API design.

Run validation during API design reviews, pre-deployment checks, and documentation audits. Early validation reduces review time, catches standards drift, and prevents deployment risks by enforcing versioning, naming, methods, and documentation rules before code ships.