新手问题 现在 Rails 大家一般用是来生成接口 spec (比如 swagger-ui)?

zealinux · 2019年06月20日 · 最后由 martin91 回复于 2019年06月20日 · 745 次阅读

如题,

找了一圈,没发现有什么好工具(+低代码量)生成 swagger-ui 页面。

感觉这方面社区不受重视还是什么其他原因?

大家的API文档是用swagger吗?还是有更好的API spec?

共收到 7 条回复

文档最终还是要人工去维护 工具只有辅助

现在比较好的spec选择:

简单的直接 rails 原生的 restful 和前端约定好格式,这个就是怎样让双方都方便就怎么来

json-api 也是不错选择,rails 这边的工具链比较完善

如果觉得 json-api 太复杂(确实有点复杂)可以考虑手动裁剪一下,然后自己做(参考第一条)

GraphQL,这个比较新,但也基本可用了

文档工具选择不多 跨语言的 swagger 一个 ruby 专有的 apipie或者类似的gem(功能弱,但简单) graphql本身文档是原生支持

另一个选择是 如果你们团队mac为主 试试 paw

没看懂标题。

Rei 回复

比如:Spring boot 框架可以很好的集成 swagger-ui.html,

只要在接口的上面加些注解,就可以自动生成对应的 “API文档网页” - 可以填参数,直接发请求

http://blog.didispace.com/springbootswagger2/ Spring Boot中使用Swagger2构建强大的RESTful API文档

Rails 中不知道用什么库?

Rails没有,只有Grape有

可以试一下 rswag 通过写spec测试来生成swagger.json 使用swagger-ui来渲染swagger页面

如果你使用jsonapi 可以试一下这个jsonapi-swaggerjsonapi resource对象直接生成swagger.json,

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