Designing APIs with OpenAPI: Build the Right APIs the Right Way.
summary
OpenAPI gets used as a prototyping language: create a plain-text three design assets story, a connection diagram, and a vocabulary, then build a spec that targets a mock prototyping server, defines reusable components: parameters, schemas, responses, requestBodies and composes paths with operationId, examples and descriptions. Practical rules: never remove or redefine existing URLs or fields, make additions optional, reuse automated tests and support reversible releases so changes stay backward compatible.
AI-written summary · about
chapters (7)
- 0:00Introduction
- 1:08API design assets
- 6:20Prototyping APIs matters
- 9:16Prototyping with OpenAPI
- 15:14Defining API paths
- 17:23Modifying APIs safely
- 19:50Summary
related talks
27mBuilding Great Web APIs
35mDocumenting APIs: new era, same craft
18mFive Essential Design Assets for Successful APIs
40mThe Four Stages of OpenAPI
22mThe Art of Effective API Design
19mSecure and accelerate APIs' lifecycle with the OpenAPI specification
30mOne Spec to Rule them all - OpenAPI in Action
30mAPI Code First vs Design First