在寫接口文檔時,當參數過多怎麼辦?認命,一個個寫下去?每一個參數都有類型、參數說明和備註等信息,那得寫到何時?特別是返回參數,隨便一個獲取詳細信息的接口裏返回的參數就夠寫一段時間,還得辛苦去整理文檔格式。 json
其實沒必要這麼麻煩,衆所周知,在開發過程當中,不少數據其實均參照json字符串標準,傳入及傳出數據通常符合json格式,那咱們就能夠充分利用json數據,來簡化編寫接口文檔的操做,下面用eoLinker接口管理平臺給你們作演示。spa
一、進入接口文檔編輯頁面,點擊導入json,輸入標準json字符串blog
二、Json中的key便保存到參數名中,而value則保存到參數的默認值裏接口
三、json導入還支持導入非標準json格式數據,即以「//」做爲註釋起點,導入json後,註釋會被錄入到參數說明中。導入後只須要簡單地把剩餘的參數信息一一填入便可。圖片
是否是很簡單呢?開發