测试 Rails 编写的 API 能否测试和文档一起做?尝试了几个 swagger 相关 gem 都没成功

imwildcat · 发布于 2017年04月25日 · 最后由 flowerwrong 回复于 2017年04月25日 · 526 次阅读
14174

大家都是怎么写 API 文档和测试 API 的呢?

共收到 11 条回复
2938

没成功是什么原因

De6df3

手工用 Markdown 写 API 文档,那些工具都最终只能玩玩而已。

安安心心用 MiniTest 或 RSpec 编写逻辑测试

9980
De6df3huacnlee 回复

不过我们公司要求把文档写在接口上面的,好坑爹啊,看了就不舒服

De6df3
9980hrz3424 回复

代码的地方当然应该要写文档,但应该有额外一份更详细的手工编写的 API 文档

当然,我也希望能有好的工具能像 RDoc/Yardoc 那样自动生成,但目前没找到好的。

9980

代码写的不是文档是注释

15420

markdown 完毕

1107

还可以用apipie的 比markdown 集成度高,比swagger轻量很多

8楼 已删除
10547

我们最开始使用github 的 wiki 来写markdown
但是经常忘记再修改完毕代码之后更新对应的markdown 最终导致文档失效。

我在想,能不能用vcr 记录下集成测试的json值 一旦有变化,自动发钉钉什么的要求开发补完,否则项目状态就是红的,之后前端只使用状态为绿的的api

14281

Rails没有找到类似 grape-swagger这样直接能用的。只发现一个swagger-docs 勉强能用,不支持最新的swagger ui,某一个2.2.x的tag可以兼容,需要手动执行生成json文件。swagger ui要自动加载也需要自己改对应js,坑挺多,不过改改还是能满足使用,现在的项目已经集成。

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