api-contract-review

This skill audits REST API contracts in Java code by checking HTTP semantics, versioning strategies, and error handling to identify anti-patterns like incorrect verb usage and missing versioning. It flags deviations from established design principles.

To check REST API versioning and backward compatibility before merging, this skill audits API controllers to verify consistent versioning strategies in URL paths and identifies potential breaking changes. It ensures adherence to HTTP semantics and best practices.

REST API design best practices for error handling require proper HTTP status codes and consistent error formats. This skill reviews your code to ensure correct status code usage, validates DTO responses, and flags improper error handling anti-patterns.

You can use this API contract review on existing Java controllers and new code alike. It analyzes your Java code for API design best practices, checking request and response validation, pagination, and backward compatibility regardless of code age.

The best way to validate REST API request and response design is auditing DTO usage and response consistency. This skill reviews your API contracts to ensure consistent responses, proper pagination, and adherence to RESTful design principles.