OpenAPI spec review
Reviews an existing contract for consistency, error handling and versioning.
IntermediateCOMMUNITY ANALYSISOpenAPI
Review the attached OpenAPI document. Check: naming consistency, HTTP status code correctness, a single error schema across operations, pagination consistency, required vs optional fields, auth definitions, versioning strategy and example completeness. For each issue give the JSON path, the problem and a corrected snippet.
Use Case
Auditing an API contract before it becomes public.
Expected Result
A list of inconsistencies with concrete replacement snippets.
Related recipe