docway推薦嗎?編寫界面文檔,方便保存和* * *分享,支持導出PDF MARKDOWN和團隊項目管理。
壹.請求參數
1.請求方法
得到
用於獲取數據。
郵政
用於更新數據,可與PUT互換,語義上PUT支持等冪。
放
用於添加數據,可與POST互換,語義PUT支持等冪。
刪除
用於刪除數據。
其他的
其他請求方法很少在通用接口中使用。例如補丁頭選項
2.統壹資源定位器
url指示接口的請求路徑。路徑可以包含稱為地址參數的參數,例如**/user/{id}**,其中id是壹個參數。
3.HTTP標頭
HTTP頭用於這個請求的基本信息,它以K-V模式顯示在接口文檔中,其中Content-Type是壹個非常必要的頭,它描述了請求體的數據類型。
常用內容類型:
application/x-www-form-urlencoded
請求參數使用“&”符號連接。
應用程序/json
內容是json格式的
應用程序/xml
內容是xml格式的
多部分/表單數據
內容由多個數據組成,用分隔符分隔。
4.HTTP正文
描述(原名逍遙雞)編寫界面文檔,方便保存和* * *分享,支持導出PDF MARKDOWN和團隊項目管理。