{"action":"created","issue":{"url":"https://api.github.com/repos/stellar/horizon/issues/2","labels_url":"https://api.github.com/repos/stellar/horizon/issues/2/labels{/name}","comments_url":"https://api.github.com/repos/stellar/horizon/issues/2/comments","events_url":"https://api.github.com/repos/stellar/horizon/issues/2/events","html_url":"https://github.com/stellar/horizon/issues/2","id":57868022,"number":2,"title":"API Blueprint from request specs","user":{"login":"nullstyle","id":366,"avatar_url":"https://avatars.githubusercontent.com/u/366?v=3","gravatar_id":"","url":"https://api.github.com/users/nullstyle","html_url":"https://github.com/nullstyle","followers_url":"https://api.github.com/users/nullstyle/followers","following_url":"https://api.github.com/users/nullstyle/following{/other_user}","gists_url":"https://api.github.com/users/nullstyle/gists{/gist_id}","starred_url":"https://api.github.com/users/nullstyle/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nullstyle/subscriptions","organizations_url":"https://api.github.com/users/nullstyle/orgs","repos_url":"https://api.github.com/users/nullstyle/repos","events_url":"https://api.github.com/users/nullstyle/events{/privacy}","received_events_url":"https://api.github.com/users/nullstyle/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/stellar/horizon/labels/enhancement","name":"enhancement","color":"84b6eb"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2015-02-17T00:24:12Z","updated_at":"2015-04-10T18:07:41Z","closed_at":null,"body":"Use something like https://github.com/playround/rspec_api_blueprint to partially automate the production of api blueprint documentation."},"comment":{"url":"https://api.github.com/repos/stellar/horizon/issues/comments/91639396","html_url":"https://github.com/stellar/horizon/issues/2#issuecomment-91639396","issue_url":"https://api.github.com/repos/stellar/horizon/issues/2","id":91639396,"user":{"login":"malandrina","id":1855523,"avatar_url":"https://avatars.githubusercontent.com/u/1855523?v=3","gravatar_id":"","url":"https://api.github.com/users/malandrina","html_url":"https://github.com/malandrina","followers_url":"https://api.github.com/users/malandrina/followers","following_url":"https://api.github.com/users/malandrina/following{/other_user}","gists_url":"https://api.github.com/users/malandrina/gists{/gist_id}","starred_url":"https://api.github.com/users/malandrina/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/malandrina/subscriptions","organizations_url":"https://api.github.com/users/malandrina/orgs","repos_url":"https://api.github.com/users/malandrina/repos","events_url":"https://api.github.com/users/malandrina/events{/privacy}","received_events_url":"https://api.github.com/users/malandrina/received_events","type":"User","site_admin":false},"created_at":"2015-04-10T18:07:41Z","updated_at":"2015-04-10T18:07:41Z","body":"If you're not feeling totally committed to API Blueprint as a tool for providing API docs you might take a look at [prmd](https://github.com/interagent/prmd). prmd generates API documentation from [JSON Schema](http://json-schema.org/) documents.\r\n\r\nDefining JSON Schema schemas for endpoint responses rather than using a tool like `rspec_api_blueprint` would allow you to avoid conforming to the tool's DSL in request specs and enforce separation of the doc-generating and system-testing concerns. The big downside of this approach is that you do have to write and maintain schemas describing the responses of all your API endpoints, and you have to define a workflow for keeping the generated docs up to date.\r\n\r\nIf you decide you'd like to try the JSON Schema approach, I'd be happy to help write the schemas."}}