Five Essential Design Assets for Successful APIs
summary
Five essential API design assets are stated and demonstrated with a running person service example: story, vocabulary, diagram, description and a technology-specific definition. The workflow shows a markdown story and a vocabulary/dictionary, an interaction diagram, ALPS or table-style descriptions, and generation of OpenAPI/AsyncAPI/Protobuf/GraphQL definitions via Smithy and TypeSpec. The Swagger editor example produces a usable OpenAPI document so definitions can generate code, docs and runtime artifacts.
AI-written summary · about
chapters (9)
- 0:00Introduction
- 1:07API design assets
- 2:54API story
- 5:40API vocabulary
- 7:27API diagrams
- 9:36API descriptions
- 13:54API definitions
- 16:24Summary
- 17:48Q&A
related talks
59mHandy Tools for Designing Great Web APIs
21mDesigning APIs with OpenAPI: Build the Right APIs the Right Way.
54mEffective Design of RESTful APIs
22mThe Art of Effective API Design
27mGetting developers hooked on your API
44mCrafting Great APIs with Domain-Driven Design
14mDesigning APIs That Humans Love
27mBuilding Great Web APIs