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

Sbh*_*ham 10 ruby api ruby-on-rails

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

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

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

任何例子?

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

谢谢!

Pau*_*lgo 1

不知道如何使用 rocco 来做到这一点,但是如果您可以更改构建器,您可以使用api_docs gem,它提供了一个很好的引导格式化输出。

api_doc 输出示例