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.

  • Conference: Write the Docs EU
  • Year: 2017

About the speaker

Garen Torikian