簡潔易讀的API文檔

開發API必然少不了編寫API文檔，API文檔所涉及的點太多，在編寫時不只要考慮到文檔的完整性，同時還須要考慮到文檔的可讀性。

完整性包括API的請求參數、響應結果、示例等等。API文檔就像一份說明書，須要記錄API的零件（API由什麼構成），還須要記錄API如何使用，而且使用時遇到的問題是不是正常的。
就像說明書同樣，API文檔會有不一樣的人查閱，這其中包括公司內部人員與外部用戶，內部人員包括開發人員、測試人員、運維人員、運營等，而外部用戶包括合做夥伴，一些雲API還包含各類各樣的須要使用雲API的用戶，例如地圖API，須要面向企業開發者或者我的開發者、學生等。而這些用戶的技術水平良莠不齊，因此文檔的可讀性是API文檔編寫者須要特別注意的。

API文檔工具

工具是API文檔編寫者的福音，一款好的API文檔工具能減小API編寫的工做量，而且優化團隊的溝通效率。在這裏推薦的是Eolinker，使用了也有兩年了，從剛開始我的測試到後來的團隊協做，一直在用這款工具。本文介紹一下該工具的API文檔部分功能。

導入功能

在Eolinker能夠對多個平臺項目進行導入，該功能能夠快速建立已有的項目。

API文檔

除了導入，還能夠在Eolinker添加新的API。在新增API界面，該工具提供了API所需內容的表單，把API信息填入表單後，便可查看API文檔。

API文檔界面能夠看到該API的全部信息。還能夠設置API變動通知，查看API版本與變動歷史，對API進行評論等。

項目分享

項目分享有兩類，一種是在線分享，一種是離線文檔，可根據不一樣用戶須要進行分享文檔。

在線分享功能能夠生成分享鏈接，在瀏覽器打開後能夠實時查看到項目內API的進展。

離線文檔支持多種格式導出，使用起來很是方便。

以上是Eolinker從建立API到分享API的簡單介紹，從界面能夠看出Eolinker所生成的API文檔簡潔、詳細，功能也很全面。感興趣或者須要使用管理工具管理API的，能夠考慮使用看看。
使用地址：[www.eolinker.com(https://datayi.cn/w/4PK51zZ9)