怎麼寫接口文檔

一些剛開始寫接口文檔的服務端同學，很容易按着代碼的思路去編寫接口文檔，這讓客戶端同學或者是服務對接方技術人員經常吐槽，看不懂接口文檔。這篇文章提供一個常規接口文檔的編寫方法，給大家參考。 一、請求參數 1. 請求方法 GET 用於獲取數據 POST 用於更新數據 PUT 用於新增數據 DELETE 用於刪除數據 其他 其他的請求方法在一般的接口中很少使用。如：PATCH HEAD OPTIONS

>>阅读原文<<