在编写相当大的REST api并寻找良好的演示文稿的同时,我遇到了stripe.com api文档:
https://stripe.com/docs/api
我最初开始在一个简单的文本文件中记录API使用情况,而我在项目上取得进展.但是现在我将让其他工程师与我和用户与API进行交互,我想生成一些像stripe.com文档.
我遇到了rocco,这很漂亮!但是我不知道条带窥镜如何格式化右侧的列来渲染粗体标题,json有效载荷和….
任何例子?
我很清楚API文档是一个相当常见的问题,但是我问的是如何使用rocco来渲染,而不仅仅是右侧的代码列.
谢谢!
不知道如何使用rocco,但是如果您可以更改构建器,您将拥有
api_docs gem,它提供了一个很好的引导格式化
输出.
原文链接:https://www.f2er.com/ruby/266267.html