时尚的rocco文档,适用于类似API的stripe.com-?

时间:2012-04-02 02:27:10

标签: ruby-on-rails ruby api

在努力记录相当大的REST api并特别寻找好的演示文稿时,我遇到了stripe.com api文档:https://stripe.com/docs/api

我最初开始在一个简单的文本文件中记录API使用情况,而我正在项目上取得进展。但现在我将有其他工程师与我合作,用户与API交互我想生成类似条带的东西.com文档。

我遇到了rocco,非常好!但我不知道条纹窥视如何格式化右手列以呈现粗体标题,json有效负载和......

任何例子?

我很清楚API文档是一个相当常见的问题,但我问的是如何使用rocco来渲染代码而不仅仅是右侧列上的代码。

THX!

1 个答案:

答案 0 :(得分:1)

不确定如何使用rocco,但如果你可以更改构建器,你有api_docs gem,它提供了一个很好的bootstrap格式化输出。

api_doc output example