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

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

搜了一圈也没有发现几个

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

共收到 12 条回复

graphql 连changlog都可以自动生成

graphql吧舒服

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

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

run99 回复

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

自己用markdown写就挺好

Stone 回复

效率低下

GraphQL API 文档生成很规范

huacnlee 回复

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

jicheng1014 回复

新项目的话首选

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