endpoint-validator

The 'endpoint-validator' skill is designed to validate REST API endpoints against the OpenAPI specification to ensure they are correctly implemented and maintain consistency in parameter definitions. This tool is essential for developers when creating or modifying API endpoints, as it ensures that the endpoints comply with the defined data structures, enforce proper validation constraints, and adhere to best practices. By using this skill, developers can catch issues early in the development process, which reduces the risk of API errors in production environments.

The skill offers several key capabilities, including validation of the 'DataStructure.php' and 'SaveRecordAction.php' files for completeness and compliance with specified patterns. It checks for the presence of required methods and attributes such as parameter type, description, and validation constraints, ensuring consistency across the API. Additionally, it tests the schema validation in strict mode and generates detailed compliance reports that offer actionable recommendations for improvement. By automating these checks, it saves time during code reviews, ensuring that any changes or additions to the API meet the desired standards.

The primary use cases for this skill include validating new API implementations, reviewing changes to existing endpoints, and preparing API code before merging changes in pull requests. It is particularly useful for teams involved in API development, code reviews, and maintaining consistency across multiple API endpoints. It can be used in any project where OpenAPI compliance and parameter validation are critical.