API文檔自動生成的方法

編寫API文檔是API編寫人員的噩夢，而API文檔一般是由API研發人員編寫。因爲API文檔建立繁瑣，須要記錄的內容比較廣，結束了API開發任務後，還要仔細編寫API文檔，給研發人員帶來額外的工做量。

隨着需求量愈來愈高，工具的誕生讓API的研發與API文檔之間的聯繫更加緊密。例如：Swagger、Eolinker、APIdoc、Easydoc等，這些API文檔管理工具不只能夠生成漂亮的在線API文檔，而且支持集成到項目自動生成API文檔。

以Eolinker爲例，Eolinker爲用戶提供了該工具的OpenAPI，方便用戶集成到開發系統。在每一個API開發完成後，快速調用OpenAPI並自動生成API文檔。

固然OpenAPI不單單是自動新增API文檔那麼簡單，Eolinker還提供了能快速對系統進行操做的OpenAPI，可集成到Jenkins等集成工具。有了這些OpenAPI，用戶能夠利用它們讓整個開發流程更加」順滑」，例如當開發完成觸發OpenAPI進行測試等。

OpenAPI只是其中一個實現方式，一些工具則經過配置文件使用依賴的方式集成到開發系統。例如Swagger2就是以這種方式生成的API文檔，而且Swagger2生成API的界面一樣漂亮、簡潔。

團隊能夠根據項目需求去挑選合適的API文檔工具，若僅對API文檔有需求，本文說起的四個工具（Swagger、Eolinker、APIdoc、Easydoc）都是不錯的選擇。若是考慮到項目須要優化整個API開發流程，並使用工具進行集成，能夠選擇一些功能強大，且容易集成到項目的API管理工具（Eolinker、APIdoc等）。
演示工具：www.eolinker.com