如何編寫API接口文檔

當完成一個API接口時，一般須要與前端人員溝通接口的細節，這時候，一個文檔就能節省不少效率，如何書寫一份正確的API文檔呢，下面是我總結網上大部分人的經驗整理的一份說明。前端 方法描述 主要說明該方法是實現什麼功能的，如用戶登陸接口 URL地址 例如 /user HTTP請求方式 該方法須要使用什麼方式來請求（GET/POST/PUT/DELETE等） 請求參數 調用該方法時，須要傳遞哪些參數值，

>>阅读原文<<