api-validator

What problem does it solve?

This Skill helps teams enforce REST API design and documentation standards, reducing review time and deployment risks by validating versioning, naming, HTTP methods, status codes, pagination, and Swagger documentation.

Core Features & Use Cases

• Versioning rules: Enforce the /v1/ prefix on all routes to maintain stable contracts.
• Resource Naming: Validate plural nouns, lowercase-with-hyphens, and no verbs in resource names.
• HTTP Methods & Status Codes: Ensure endpoints use the correct methods and status codes (e.g., 201 for create, 200/204 for reads/deletes).
• Pagination: Require list endpoints to support pagination DTOs and structured responses.
• Swagger/OpenAPI Docs: Verify full OpenAPI documentation coverage for all endpoints.
• Error Mapping: Check consistent error status usage and descriptive messages.
• Use Case Scenarios: Useful during pre-deployment checks, API design reviews, and documentation completeness verification.

Quick Start

• Run the API validator against your project to check /v1/ routes, naming, HTTP methods, pagination, and Swagger docs.
• Example input: "Validate the User API endpoints"