Contract First API Design with OpenAPI V3
summary
OpenAPI V3 adds tangible features not buzzwords: links and callbacks let one operation reference another so clients can follow workflows; the new requestBody and content model replaces produces/consumes and supports 201 created responses with explicit schemas; tools like Swagger Editor, Swagger UI and a VS Code preview validate and render specs and can generate mock servers and multi-language clients. Example work includes converting Microsoft Graph to OpenAPI (≈1M lines JSON, 30MB) and a .NET parser that upgrades/downgrades v2↔v3; reuse comes from components and $ref fragments.
AI-written summary · about
chapters (22)
- 0:00Introduction
- 6:50Contract First
- 14:10Create Contract
- 15:35Minimum Requirements
- 17:20Operations
- 24:45Description
- 26:35JSON Response
- 29:06Parameters
- 30:28Wildcarding
- 32:26Links
- 33:23List of Sessions
- 34:38Filtered Sessions
- 35:42Resource Relationships
- 36:25Resources Relationship Diagram
- 37:33Content Types
- 38:41OpenAPI
- 43:26OpenAPI Components
- 50:53Reuse
- 54:21Change
- 56:51Single Pitch
- 57:48Who does it
- 58:26More information
