API Documentation generation

Hey there,

We need to generate a documentation for our new API written with jsonapi-resources (oh yeah!), authenticated with doorkeeper (OAuth2) and versioned with versionist (HTTP Header).

I have reviewed some tools (api-blueprint, apipie, swagger, slate, ...) and would like to know what's your position on them. Do you already have a preference?

It seems obvious there's already a lot of logic encapsulated inside our API resources/routes files and that we should be able to generate some documentation automagically instead of rewriting everything manually to some markdown/yaml/... files.

Do you think starting something like grape-apiary make sense? Is it too early, maybe not enough stable API yet?

Let start the discussion!

/cc @barelyknown & @dgeb If I remember well, you discuss this on a the Ruby on Rails Podcast 187

审查现有的 API 资源/路由文件，以及 jsonapi-resources、doorkeeper 和 versionist 的要求。比较提到的工具，包括 api-blueprint、apipie、Swagger、Slate 和 grape-apiary。就文档生成方案及其范围达成一致即视为完成；该 issue 未指定具体文件或测试。