Hacker News new | ask | show | jobs
by dtsingletary 5073 days ago
Thanks for mentioning the Klout API docs (http://developer.klout.com). They're a work in progress, but we lean heavily on Mashery's I/O Docs solution for self-documenting response and request formats. I continue to work on expanding out more detailed docs, but I generally feel strongly that API docs should be entertaining and tell a story. This aligns fairly well with how Dwolla (http://developers.dwolla.com/) aimed their portal at both business and developers.

As an aside, we use Swagger internally to manage and self-document here, and then I/O Docs on the third-party developer side. It's a nice separation of concerns.