Finally! Trustworthy and Sensible API Documentation with GraphQL

Befd819b3fced8c6bd3dba7e633dd068?s=47 Garen Torikian
September 12, 2017

Finally! Trustworthy and Sensible API Documentation with GraphQL

GitHub is migrating its public API system from REST to GraphQL. In this talk, I'd like to go over my personal experiences writing API documentation for ten years, and why GraphQL's "everything needs documentation" approach is a much needed improvement. I'd go over past API tooling and methodologies, current best practices to make "sane" autogenerated API documentation, and why I think that GraphQL is a boon for technical writers, developers, and end users.

Befd819b3fced8c6bd3dba7e633dd068?s=128

Garen Torikian

September 12, 2017
Tweet