Today we’re open sourcing the toolchain Heroku uses to design, document, and consume our HTTP APIs. We hope this shows how Heroku thinks about APIs and gives you new tools to create your own.
This toolchain includes:
An HTTP API design guide, describing how we structure both internal and public-facing APIs and document them using the JSON Schema standard.
A tool for working with JSON schemas and using them to generate API documentation.
Here’s some more information about these things, how we use them at Heroku, and an explanation of how you can try them yourself.
We’ve developed the toolchain around...