Trustworthy and Sensible API Docs with GraphQL
summary
Argues that GraphQL makes reference docs trustworthy by turning the schema into executable documentation so documentation is the code rather than a separate, rot-prone artifact. Uses GraphQL schemas, introspection and the GraphiQL IDE with GraphiQL autocomplete and shows a live demo site (welp.reviews) that works. Shows a quick test that diffs schemas to catch a removed current_user field. Notes Facebook used GraphQL internally five years before open sourcing in 2015 and GitHub adoption in 2016.
AI-written summary · about
chapters (13)
- 0:00Introduction
- 7:54Documentation
- 8:36DakaMatic
- 10:00Problems with Documentation
- 12:14Language
- 13:12Language grammar
- 14:05Comments and documentation
- 15:23Different languages
- 17:00Code Docs
- 18:57GraphQL Schema
- 20:50GraphQL Documentation
- 22:40Testing Documentation
- 24:35Conclusion
