如何下降API文檔對接成本

API是應用程序的核心組成部分，API文檔則詳細記錄如何使用應用程序，以及當應用程序出現問題時，幫助技術人員快速定位問題。一份完善的API文檔應考慮到API的方方面面，甚至是API開發的交接工做。

團隊內部人員流動時，對接工做是一個使人頭疼的問題。在找到對接人以前，須要涉及到多個部門，找到對接人後，還須要對對接人進行工做任務內容的交接。對於像API文檔這種涉及面廣且文檔內容比較細的文件，若是API文檔自己存在缺陷，則對接成本將大大提升。

使用Office工具記錄API

一些團隊使用Office文檔記錄API。雖然Office是強大的文檔工具，但排版是一個大問題，在使用Office記錄API文檔初期，就須要把文檔排版作好。而Office的維護難度高，一旦須要交接，講解將變得困難。若排版不合適或文檔維護有問題，隨着API的數量增長，維護的難度與成本更高。

使用API文檔管理工具記錄API

使用API文檔工具的好處在於文檔可讀性高、易維護、詳細等。

目前市場有許多API文檔工具，其中界面清晰、功能完善的工具備Postman、Swagger、Eolinker。Postman可記錄API，測試功能也強大，但偏向測試，文檔方面沒有比Swagger、Eolinker出色。Swagger文檔應該都不陌生，界面配色好看。Eolinker則適合各類規模的企業，本文使用Eolinker進行演示。
API工具在展現API時，不只可包含API的基礎信息，如請求參數、url等，還可查看API 的狀態、示例。Eolinker還能夠查看變動歷史與對比變動歷史。

使用API管理工具進行對接，只須要指導對接人如何查看API文檔，應界面都是可視化操做，因此在使用上與維護上也比較簡單。

若是有打算讓API文檔保持簡單且易對接的團隊，能夠嘗試使用API管理工具進行API管理，它們不單單是文檔工具，其中還包含強大的測試功能。
演示工具使用地址：www.eolinker.com