什麼時候需要API文件
- 開發中，前後端經常需要介面聯調、功能對接、兩個人的開發節奏不一致，這時候就需要API文件。
- 遠端協作，兩個人溝通不便，一個好的文件是很有必要的，可以省去很多不必要的溝通。
- 人員離職，新人接手專案，如果沒有文件，你只能通過看程式碼來了解介面的引數和呼叫方法，這種時候API文件就很有必要了
- 測試人員測試時，需要按照API文件來測試介面的可用性
編寫API文件的痛苦
編寫API文件，對於大多數開發者而言，都是痛苦的，很多人還在用txt、word、markdown這類編輯器來寫，編寫很麻煩，如果有多層級的子引數，更加是不知道如何表達好。 每次寫完文件，還要手動同步給不同的協作者。
選用好工具
網上已經有很多API的編寫工具了，我體驗了十幾個這類工具，但是大部分都還是在用markdown編寫，編寫體驗都不好，預覽效果也不夠優雅。經過各種對比使用，我推薦大家使用 易文件，直接看效果：簽到文件， 官方示例文件，易文件他有http專屬的編輯器，編寫特別方便，全程可以只用鍵盤搞定，還支援介面線上測試，一鍵生成mock
掌握好技巧，編寫簡單快速
易文件官方有提供各種 技巧教程，只要大家掌握好這些技巧，文件的編寫就變得很輕鬆了