JSON API文檔工具

2011-09-26 77 views 2 likes

是否有工具或簡單的方法來生成/維護富RESTful JSON API的文檔？JSON API文檔工具

我也想發佈和維護（作爲可執行文檔）它，就像relishapp提供的東西。 An example。

該應用程序是Restful Ruby on Rails 3應用程序，使用cucumber和R-Spec控制器測試進行測試。

2011-09-26 jake

爲什麼不使用[rdoc]（http://rdoc.rubyforge.org/）或該家族的某些東西？它將您的源代碼的註釋轉換爲api瀏覽器。 – wulftone

謝謝，這很好。但我想要更像黃瓜，你不斷運行（紅色/綠色），只是保持。 – jake

回答

你說你已經有黃瓜測試 - 他們是你的文檔。他們可能只需要一些工作來閱讀。

對於輸出，您可以使用Cucumber的內置HTML格式器。

2011-09-26 17:06:55

是的，我在大多數情況下都這麼做，但我正在尋找更適合JSON API的東西，這將有助於開發人員更好地使用JSON API。隨着所有的請求響應，參數等，但不必使黃瓜非常冗長。 – jake

相關問題