Rails 用 Rails 写后端 API，请问有什么自动生成 API 文档的 gem 吗

www · 2019年10月03日 · 最后由 hooopo 回复于 2019年10月15日 · 4502 次阅读

搜了一圈也没有发现几个

看见个比较合适的 https://github.com/rswag/rswag 发现文档不全

gwq #1 2019年10月04日

1 个赞

hooopo #2 2019年10月04日

graphql 连 changlog 都可以自动生成

2 个赞

lidashuang #3 2019年10月04日

graphql 吧舒服

lidashuang #4 2019年10月06日

https://github.com/72pulses/apidoco Apidoco - Ruby on Rails API documentation tool

run99 #5 2019年10月07日

你所提到的 rswag，我个人认为就是 Rails 下的最好用的工具了。文档不全是什么意思？rswag 是基于 swagger 的，真正的文档是 OpenAPI Specification 的 2.0 版和 3.0 版。

www #6 2019年10月12日

对

rswag 语法方面的文档，README 只给了个示范，再也找不到其他的说明了，估计只能看源码来解决。

Stone #7 2019年10月12日

自己用 markdown 写就挺好

lidashuang #8 2019年10月14日

对

效率低下

huacnlee #9 2019年10月14日

GraphQL API 文档生成很规范

jicheng1014 #10 2019年10月14日

对

现在 graphql 已经是大势所趋了么？

reducm #11 2019年10月15日

hooopo #12 2019年10月15日

对

新项目的话首选

需要登录后方可回复, 如果你还没有账号请注册新账号

Rails 用 Rails 写后端 API，请问有什么自动生成 API 文档 的 gem 吗