網(wǎng)站推廣的一般流程是,網(wǎng)站錄入信息 前臺(tái)查詢功能怎么做,怎么經(jīng)營網(wǎng)店生意才會(huì)好,seo網(wǎng)站的優(yōu)化流程文章目錄一、接口文檔1.1 接口文檔介紹1.2 接口文檔內(nèi)容二、接口文檔解析2.1 登錄接口文檔2.1.1 基本信息2.1.2 請求參數(shù)2.1.3 返回?cái)?shù)據(jù)2.2 登錄接口文檔解析一、接口文檔 1.1 接口文檔介紹 接口文檔#xff1a;又稱為API文檔#xff0c;一般是由后端開發(fā)人員所編寫的…文章目錄一、接口文檔1.1 接口文檔介紹1.2 接口文檔內(nèi)容二、接口文檔解析2.1 登錄接口文檔2.1.1 基本信息2.1.2 請求參數(shù)2.1.3 返回?cái)?shù)據(jù)2.2 登錄接口文檔解析一、接口文檔1.1 接口文檔介紹接口文檔又稱為API文檔一般是由后端開發(fā)人員所編寫的用來描述系統(tǒng)所提供接口信息的文檔。1、為什么要寫接口文檔 - 能夠讓前端開發(fā)與后端開發(fā)人員更好的配合提高工作效率。(有一個(gè)統(tǒng)一參考的文件) - 項(xiàng)目迭代或者項(xiàng)目人員更迭時(shí)方便后期人員查看和維護(hù)。 - 方便測試人員進(jìn)行接口測試。 2、展現(xiàn)形式 - word 文檔形式 - Excel 表格式形式 - pdf 文檔形式。1.2 接口文檔內(nèi)容一個(gè)規(guī)范的接口文檔要包含以下信息1、基本信息資源路徑協(xié)議和域名在 “系統(tǒng)信息”中請求方法接口描述2、請求參數(shù)請求頭Content-Type。描述請求體的數(shù)據(jù)類型請求體包含具體的請求參數(shù)名稱、參數(shù)類型、是否必須、示例、備注3、返回?cái)?shù)據(jù)不同情況的響應(yīng)狀態(tài)碼成功響應(yīng)數(shù)據(jù)包含具體的響應(yīng)數(shù)據(jù)名稱、類型、是否必須、默認(rèn)值、示例、備注)二、接口文檔解析2.1 登錄接口文檔2.1.1 基本信息Path http://ihrm2-test.itheima.net/api/sys/loginMethod POST接口描述:2.1.2 請求參數(shù)Headers參數(shù)名稱參數(shù)值是否必須示例備注Content-Typeapplication/json是Body名稱類是否必須默認(rèn)值備注其他信息mobilestring必須手機(jī)號(hào)passwordstring必須密碼2.1.3 返回?cái)?shù)據(jù)操作成功響應(yīng)狀態(tài)碼200錯(cuò)誤碼描述10000操作成功20001用戶名或密碼錯(cuò)誤99999抱歉系統(tǒng)繁忙請稍后重試名稱類型是否必須默認(rèn)值備注successbool是操作成功標(biāo)記codeint是10000錯(cuò)誤碼messagestring是操作成功消息datastring是令牌token{success:true,code:10000,message:操作成功,data:xxx}{success:false,code:20001,message:用戶名或密碼錯(cuò)誤,data:null}{success:false,code:99999,message:抱歉系統(tǒng)繁忙請稍后重試,data:null}2.2 登錄接口文檔解析接口文檔的解析本質(zhì)從接口文檔中找出 http 請求所需要的 數(shù)據(jù)信息。1、http請求相關(guān)數(shù)據(jù) ——①請求方法 ——②URL ——③請求頭 ——④請求體數(shù)據(jù)類型 2、http響應(yīng)相關(guān)數(shù)據(jù)預(yù)期結(jié)果 ——①響應(yīng)狀態(tài)碼 ——②響應(yīng)體以 “登錄” 為例請求方法POSTURLhttp://ihrm2-test.itheima.net/api/sys/login請求頭Content-Type:application/json請求體{“mobile”:”13800000002”, “password”:”888itcast.CN764%…”}響應(yīng)狀態(tài)碼200錯(cuò)誤碼10000操作成功20001用戶名或密碼錯(cuò)誤99999抱歉系統(tǒng)繁忙請稍后重試