API Contract Review
Review an API contract or specification (OpenAPI/REST/GraphQL) for correctness, consistency, and developer ergonomics, then produce a findings report. First scopes the surface and locks an API design checklist (resource naming and HTTP semantics, status codes, pagination and filtering, error schema consistency, auth, versioning and backward compatibility, idempotency, and schema/type rigor), then reviews each endpoint and type against those rules and REST/GraphQL best practices, then writes a findings report rating each issue and giving the corrected contract snippet. Use this for an API design review, reviewing an OpenAPI/Swagger spec, a REST or GraphQL contract review, endpoint/schema critique, or checking an API for consistency and backward compatibility before it ships — it returns specific, spec-anchored fixes rather than 'make the API cleaner'.
How it runs
| # | Step | Who runs it | What happens |
|---|---|---|---|
| 1 | Scope the contract review | Reviewer | map the surface, lock an API design checklist |
| 2 | Review the endpoints | Developer | check each operation + type against the rules |
| 3 | Write the contract report | Reviewer | findings with corrected snippets + compat verdict |
| 4 | Evaluate | Reviewer | Grade the deliverable against every acceptance criterion. All pass → finish; any fail → loop back and fix the gap. |
| 5 | Finish | Developer | All acceptance criteria met. Stamp a short summary and report DONE. |
Say something like "api contract review" or "review my openapi spec" or "review this REST API" or "graphql schema review" or "is this api backward compatible" or "api design review" in chat to start it.