2014-03-25 33 views
9

您好我正在使用Apiary維護我的REST API的文檔,因爲我們的代碼基礎越來越多,我們的API文檔越來越大。將所有的API放入單個藍圖文件中變得非常困難,我們是否有任何方法可以將它們正確地組織到多個文件中並在蜂房內顯示它們。蜂房多個藍圖文件合併爲一個api

回答

11

是的,有一種沒有文檔記載的方式(它很醜,但是很有效):如果你連接到github,你可以在你的倉庫的根目錄下創建一個名爲apiary.manifest的文件。

在裏面,您可以放置​​以換行順序連接並顯示在您的apiary子域中的相對路徑的換行符分隔列表。

請注意,但是,養蜂場目前不提供一個很好的方式來編輯在養蜂場的編輯器。如果您將其保存在那裏,則只會將連接版本保存爲apiary.apib回到您的回購庫(這就是爲什麼它沒有記錄)。

您必須使用自己的編輯器進一步編輯藍圖,即使用apiary plugin來昇華藍圖。

+0

你是否會用cli客戶端來支持它?謝謝:) – mojzis

+2

@mojzis絕對;我們只想要比清單文件更好地配置藍圖工具。 – Almad

+0

太棒了!期待 :) – mojzis

相關問題