還在糾結接口文檔的事兒呢？

寫的什麼？

如今開發都要用到接口文檔。不寫的話代碼不知道怎麼維護，寫的話又費時費力，更煩人的是有時候寫完了前端還要來問這個參數那個參數，真的苦不堪言。
在先後端分離的近幾年，寫接口文檔對我來講是老大難，後面特意去查了自動化工具的理論，才茅塞頓開。至少對於寫文檔的思路清晰了許多！
那麼如今就來分享一下我怎麼作的吧！

要作什麼？

咱們的目標，是寫出清晰簡練的文檔。因此，首先咱們要肯定：怎麼纔是清晰簡練的文檔。
以下圖所示：

上面的文檔簡練在哪？

首先，讓你知道它的功能，參數，一目瞭然；
其次，你輸入參數就能立刻看到結果。

我但願的是在完成代碼後，能夠費不多的力氣，就生成一個像上圖所示的可調試文檔。
那麼接下來要作兩件事：
一、自動生成可視化的文檔；
二、文檔可調試。

怎麼協做？

一是能夠直接在工具裏完成整個項目，二是導出不一樣格式的項目文檔，可用於其餘文檔工具。

結語

我實現的工具是Eolinker
使用地址是：www.eolinker.com
相似的工具備不少， swagger editor，gwsee，apidoc，都還能夠。
寫這篇文章不是推薦什麼工具，可是本身走過一遍，確定會有收穫哈哈:)