The Augmented API Design Reviewer
summary
Shows how OpenAPI plus a linter automates guideline checks using Spectral to catch style and schema issues so reviewers spend time on design not syntax. Implements about 70 rules organized into 10 rule sets with severity levels (error/warning/info/hint), backed by roughly 400 tests that run Spectral as a Node library and verify jsonpath behavior with jsonpath-plus. Integrates CLI, Stoplight Studio, jq and CSV export to summarize hundreds of findings; it reduces oversight and speeds reviews.
AI-written summary · about
chapters (12)
- 0:00Start
- 0:42Arnaud Lauret, API Handyman Senior API Architect at Natixis, helping people understand and create APIs
- 1:03API Design Reviews API Design Reviewer's Starter Set
- 1:22The Augmented API Design Reviewer Improving API Design Reviews
- 2:39API Design Review Problem
- 4:05Machine Readable API Description
- 4:52API Description Linter
- 11:27Ruleset Design Rule Severity
- 13:35Testing Rulesets
- 18:05Designing Rulesets Take aways
- 18:52Using Spectral in 3 Different Ways
- 20:55The Augmented API Design Reviewer Take aways
related talks
24mAugmented API Design Review with OpenAPI and Spectral
23mAPI Design Reviewer's Starter Set
25mAutomating API Governance
36mAPI Governance in an Anti Governance World
40mAPI Lifecycle: Smarter Design and Governance With Open Tooling
26mAPI Governance: The Latest Trends Making Teams Love API Standardization.
30mSimplifying API Review - A Tool Based Approach for Kubernetes and Beyond
26mBuilding APIs for Developers & Machines