Generating docs from APIs
summary
Builds a small Flask app that serves a cat API, proves curl requests return expected JSON, and shows a screencast of the server working. Central claim: define data once with JSON Schema so types, enums, lengths and defaults are canonical. Uses Swagger to map paths, verbs, response codes, embed the schema, generate live docs, a sandbox, SDKs (PHP etc.) and even server stubs via Docker; duplication and drift disappear.
AI-written summary · about
chapters (16)
- 0:00Intro
- 1:35Communication
- 2:55API definition
- 4:06Abstract
- 4:32Our job
- 6:08API structure
- 7:19Demo
- 9:19Documentation
- 15:46Status
- 17:11Summary
- 18:08Validation
- 18:36Schemas
- 19:09HTTP verbs
- 20:05Swagger
- 22:21Swagger Documentation
- 27:07Wrap up
related talks
35mFake It Before You Make It: Mocking Your Way to Better HTTP APIs
27mGetting developers hooked on your API
21mLet there be docs!
27m"Building Elegant API Contracts: From Zero to Hero"
01h 23mDocumenting RESTful APIs
33mDocumenting REST APIs with Swagger
47mBuilding APIs your users will want to use
57mDocumenting RESTful APIs with Spring REST Docs