2012-01-15 68 views
4

我正在創建一個REST API來與我們正在構建的一個新的SaaS站點進行接口,我們需要記錄這個API供第三方iOS開發人員使用(以及其他開發人員,一旦該服務上市) 。是否有任何現有的數據庫驅動的內容管理系統可以幫助爲這類系統構建API文檔?是否有任何CMS引擎用於爲REST API創建參考文檔?

我希望有更多的東西比一般的wiki或wordpress構建提供的定製。

編輯:我應該提到我們的VPS設置爲LAMP堆棧,所以PHP驅動的東西會更可取。

自我記錄不是要求,我實際上想要更多的手動。我想使用CMS作爲還需要編寫的API的設計平臺。

回答

9

I/O Docs是在nodejs上運行的交互式文檔系統。您可以爲您的API生成JSON模式,並提供描述您的API的HTML/JS網站,並允許開發人員通過其瀏覽器實時播放它。

Swagger是生成API文檔和運行自己的文檔站點框架的規範。

雖然文檔Apigee ToGo的替代文件不會替代更通用的CMS文檔。

Sphinx不是面向REST的,但會生成一般文檔。

如果你正在用Java編寫你的API Enunciate也是值得關注的。它將從JavaDocs構建文檔。

+0

代是不是一個要求,我其實寧願被手工輸入它,因爲這也將用於計劃的API。感謝您的建議 – ChiperSoft 2012-01-15 22:26:53

+0

我不知道任何專爲REST文檔設計的CMS,但Drupal具有很強的可擴展性,並且Google協作平臺非常易於使用。 – abraham 2012-01-15 22:37:38