2012-04-02 16 views
10

雖然記錄上一個相當大的REST API,尋找特別好的演示文稿,我整個stripe.com API文檔出來但現在我將有其他工程師與我一起工作,並且用戶與API進行交互,我希望生成類似stripe.com文檔的東西。用於類似API的stripe.com-的時尚rocco文檔? <a href="https://stripe.com/docs/api" rel="noreferrer">https://stripe.com/docs/api</a></p> <p>我最初開始在一個簡單的文本文件記錄API的使用,而我做的進展:

我碰到了rocco,它非常好!但我不知道如何條紋peeps格式化右欄以呈現粗體標題,json有效載荷和...

任何示例?

我很清楚API文檔是一個相當常見的問題,但我問的是如何使用rocco類似於渲染右側列的代碼。

Thx!

回答

1

不知道如何與rocco做到這一點,但如果您可以更改生成器,您可以使用api_docs gem,它提供了一個不錯的引導格式化輸出。

api_doc output example

相關問題