能夠自動更新API文檔

Question

我正在爲外部開發人員提供API的網站上工作。

無論何時更新API（即修改參數，新結束點等），我都必須手動更新文檔。

所以我看着這個過程如何自動完成。這是我希望達到的目標：一旦我的源代碼被更新並提交給我的源代碼控制，某種API註冊表將會被更新。所以我的文檔可以是一個應用程序，它引用註冊表並向最新的API顯示查看器。

我的網站基於Ruby on Rails。

Answer 1

RDoc是根據你的源代碼自動生成的，它是默認的Rails。你的代碼需要證據充分的，但如果是這樣，你可以只運行

bundle exec rake doc:app 

和您的應用程序會生成從doc/app/index.html訪問文檔。我會看看，看看這些文件是否符合你的需求。 「類和模塊索引」側欄中的鏈接包含您的所有方法的列表，其中包含可擴展的源代碼視圖。

我使用自定義Rake任務，將所有文檔放在Rails公用文件夾中，以便直接從我的網站訪問，並允許我添加多個自定義頁面。我想對你來說做類似的事情並不難，只能解析你的API文件。

鏈接：

RDoc Syntax Help

Project on Github