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

www · October 03, 2019 · Last by hooopo replied at October 15, 2019 · 4502 hits

搜了一圈也没有发现几个

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

gwq #1 October 04, 2019

1 likes

hooopo #2 October 04, 2019

graphql 连 changlog 都可以自动生成

2 likes

lidashuang #3 October 04, 2019

graphql 吧舒服

lidashuang #4 October 06, 2019

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

run99 #5 October 07, 2019

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

www #6 October 12, 2019

Reply to

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

Stone #7 October 12, 2019

自己用 markdown 写就挺好

lidashuang #8 October 14, 2019

Reply to

效率低下

huacnlee #9 October 14, 2019

GraphQL API 文档生成很规范

jicheng1014 #10 October 14, 2019

Reply to

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

reducm #11 October 15, 2019

hooopo #12 October 15, 2019

Reply to

新项目的话首选

You need to Sign in before reply, if you don't have an account, please Sign up first.

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