Rails 5的API文档工具

时间:2018-02-09 07:38:46

标签: ruby-on-rails ruby-on-rails-5 swagger rails-api api-doc

我有一个仅限API的应用程序需要前端开发人员的文档。这是我第一次体验它。

您为此目的使用了什么工具?请注意,我使用的是rails 5 API而不是Grape。

我测试了Apipie,swagger-blocks和swagger-docs宝石,但它们已经过时或有缺陷。必须有更好的选择!
任何建议都得到尊重

2 个答案:

答案 0 :(得分:2)

好吧,我发现Slate是最好的之一。

答案 1 :(得分:1)

您是否尝试过RSpec Api文档? https://github.com/zipmark/rspec_api_documentation

有一篇关于在代码中使用它的文章:https://blog.codeship.com/producing-documentation-for-your-rails-api/