如何使用eolinker一鍵快速生成API接口文檔

現公司已經有很多接口託管在eoLinker上了,最近由於須要提供接口文檔給甲方,以前使用eoLinker的初衷主要是其接口文檔清晰簡潔有條理,也可用於協做、在線分享。如今項目組經理頓時慌了,用時一時爽,一直依賴eoLinker來進行接口文檔的管理,哪有寫什麼pdf格式的接口文檔啊。
慶幸的是,發現eoLinker支持一鍵生成Api文檔,出於興趣,對其導出功能簡單研究了一下。這裏做爲經驗分享給你們~html

導出接口文檔,首先進入須要導出的項目的概況頁面,找到「導出項目」選項,點擊json

圖片描述

選擇須要導出的項目格式,這裏可導出eoLinker格式、html格式、企業版支持導出pdf格式和word格式。工具

圖片描述

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

圖片描述

導出格式爲json,方便導入導出,不便閱覽。3d

若導出爲html格式,其實際導出爲zip壓縮包,包裏包括html樣式及相關數據,從index.html中進入。htm

圖片描述

eoLinker企業版支持還導出pdf格式和word格式,其導出的內容格式剛好和咱們平時寫文檔的習慣類似,導出的文檔就像是咱們本身編寫的同樣。
導出pdf文檔blog

圖片描述

導出word文檔接口

圖片描述

圖片描述

好工具當然重要,但切實利用好工具的功能,才能提升工做的效率。圖片

相關文章
相關標籤/搜索