Getting developers hooked on your API
summary
Claim: there are 15,000 APIs and standing out requires focusing on real developer UX not buzzwords. Shows using Swagger/OpenAPI specs and a JSON metadata source plus mustache templates to auto-generate docs, code samples and response examples so teams stop hand-writing snippets and cut support load. Recommends interactive sandboxes, Slate for readable docs, sample apps (Algolia-style ecommerce demo) and open-sourcing docs; the generated approach works and speeds iteration while keeping examples current.
AI-written summary · about
chapters (15)
- 0:00Introduction and welcome
- 1:03Meet the speaker
- 2:50Why APIs need to stand out
- 4:19APIs are for people
- 6:05Simplicity in API design
- 8:10Affordance and consistency
- 10:14Know your API users
- 11:17Documentation as first interface
- 13:24Swagger and API specs
- 14:35Pragmatism and code snippets
- 16:49User guides and tutorials
- 18:56Sample apps and demos
- 20:01Iterating and maintaining docs
- 22:35Leveraging developer feedback
- 24:44Conclusion and call to action
related talks
31mGetting developers hooked on your API
35mDev Experience in Technical Writing: 15 Tips to Boost Developer Satisfaction
35mOpenAPI for Documentarians
35mDocumenting APIs: new era, same craft
59mHandy Tools for Designing Great Web APIs
21mLet there be docs!
22mBeyond the Spec: Making OpenAPI More Human
14mDesigning APIs That Humans Love