Ruby   发布时间:2022-04-03  发布网站:大佬教程  code.js-code.com
大佬教程收集整理的这篇文章主要介绍了ruby-on-rails – REST API文档生成大佬教程大佬觉得挺不错的,现在分享给大家,也给大家做个参考。
是否有一个库提供用于编写​​REST API文档的标记?我见过几家公司使用类似的文档模式,例如:

http://api.teamlab.com/2.0/

http://www.fullcontact.com/docs/?category=person

我想知道他们是否使用相同的库或服务.本质上,库应该基于标记文本生成用于API导航,搜索和显示的页面(非常类似于用于ruby文档的YARD).

这是我到目前为止所发现的:

> rapi_doc gem.这是一个讨论用法的article.

解决方法

你一定要看看 Swagger.

是开源的,由数百个API使用,3scale也在其名为Active Docs的API Management解决方案中使用.

大佬总结

以上是大佬教程为你收集整理的ruby-on-rails – REST API文档生成全部内容,希望文章能够帮你解决ruby-on-rails – REST API文档生成所遇到的程序开发问题。

如果觉得大佬教程网站内容还不错,欢迎将大佬教程推荐给程序员好友。

本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。