Augmented API Design Review with OpenAPI and Spectral
summary
Automates guideline checks by linting OpenAPI with Spectral and JSON Schema, turning minutes of manual conformance work into seconds; uses the CLI, Stoplight Studio, jq and CSV exports for workshops, and mocha tests plus jsonpathplus to validate rules. Rule library grows to 71 rules organized in 10 rule sets with over 400 unit tests to ensure accuracy. Spectral flags naming, path structure, schema and pagination issues, surfaces severity levels, and proves effective at reducing oversight and speeding reviews.
AI-written summary · about
chapters (7)
- 0:00Introduction
- 1:06API design review challenges
- 4:18Automate reviews with OpenAPI and Spectral
- 8:34Scaling Spectral rulesets
- 19:52Best practices for Spectral rulesets
- 20:34Integrating Spectral into workflow
- 22:18Summary
related talks
24mThe Augmented API Design Reviewer
25mAutomating API Governance
36mAPI Governance in an Anti Governance World
23mAPI Design Reviewer's Starter Set
43mImprove your API and OpenAPI
22mSpecification-Driven Development of REST APIs
29mBringing OpenAPI to devOps
31mUnifying OpenAPI & AsyncAPI : Designing JSON Schemas+Examples.