寫(xiě)的什么？

現(xiàn)在開(kāi)發(fā)都要用到接口文檔。不寫(xiě)的話(huà)代碼不知道怎么維護(hù)，寫(xiě)的話(huà)又費(fèi)時(shí)費(fèi)力，更煩人的是有時(shí)候?qū)懲炅饲岸诉€要來(lái)問(wèn)這個(gè)參數(shù)那個(gè)參數(shù)，真的苦不堪言。
在前后端分離的近幾年，寫(xiě)接口文檔對(duì)我來(lái)說(shuō)是老大難，后面特地去查了自動(dòng)化工具的理論，才茅塞頓開(kāi)。至少對(duì)于寫(xiě)文檔的思路清晰了許多！
那么現(xiàn)在就來(lái)分享一下我怎么做的吧！

要做什么？

我們的目標(biāo)，是寫(xiě)出清晰簡(jiǎn)練的文檔。所以，首先我們要確定：怎么才是清晰簡(jiǎn)練的文檔。
如下圖所示：

上面的文檔簡(jiǎn)練在哪？

首先，讓你知道它的功能，參數(shù)，一目了然；
其次，你輸入?yún)?shù)就能馬上看到結(jié)果。

我希望的是在完成代碼后，可以費(fèi)很少的力氣，就生成一個(gè)像上圖所示的可調(diào)試文檔。
那么接下來(lái)要做兩件事：
1、自動(dòng)生成可視化的文檔；
2、文檔可調(diào)試。

怎么協(xié)作？

一是可以直接在工具里完成整個(gè)項(xiàng)目，二是導(dǎo)出不同格式的項(xiàng)目文檔，可用于其他文檔工具。

結(jié)語(yǔ)

我實(shí)現(xiàn)的工具是Eolinker
使用地址是：www.eolinker.com
類(lèi)似的工具有很多， swagger editor，gwsee，apidoc，都還可以。
寫(xiě)這篇文章不是推薦什么工具，但是自己走過(guò)一遍，肯定會(huì)有收獲哈哈:)