天天看點

利用eolinker一鍵快速生成API接口文檔

現公司已經有不少接口托管在eoLinker上了,使用eoLinker的初衷主要是其接口文檔清晰簡潔有條理,也可用于協作、線上分享。最近因為需要提供接口文檔給甲方,項目組經理頓時慌了,用時一時爽,一直依賴eoLinker來進行接口文檔的管理,哪有寫什麼pdf格式的接口文檔啊。慶幸的是,發現eoLinker支援一鍵生成Api文檔,出于興趣,對其導出功能簡單研究了一下。

導出接口文檔,首先進入需要導出的項目的概況頁面,找到“導出項目”選項,點選

利用eolinker一鍵快速生成API接口文檔

選擇需要導出的項目格式,這裡可導出eoLinker格式、html格式、企業版支援導出pdf格式和word格式。

利用eolinker一鍵快速生成API接口文檔

若想讓項目再次導入到eolinker平台上,則需要導出eoLinker格式,eolinker格式實際為json字元串。(eoLinker格式是開源及線上版的通用導入導出格式)

利用eolinker一鍵快速生成API接口文檔

導出格式為json,友善導入導出,不便閱覽。

若導出為html格式,其實際導出為zip壓縮包,包裡包括html樣式及相關資料,從index.html中進入。

利用eolinker一鍵快速生成API接口文檔

eoLinker企業版支援還導出pdf格式和word格式,其導出的内容格式恰好和我們平時寫文檔的習慣相似,導出的文檔就像是我們自己編寫的一樣。

導出pdf文檔

利用eolinker一鍵快速生成API接口文檔

導出word文檔

利用eolinker一鍵快速生成API接口文檔
利用eolinker一鍵快速生成API接口文檔

 好工具固然重要,但切實利用好工具的功能,才能提高工作的效率。

繼續閱讀