1、XZ學子商城交互接口設(shè)計說明書文檔編號 XZ-30321.概述41.1.交互接口概述41.2.接口清單42.接口定義52.1.范例說明52.1.1.參數(shù)語法52.1.2.返回值語法52.2.代碼含義53.“基本信息”模塊63.1.用戶名是否存在接口63.2.郵箱是否存在接口63.3.手機號是否存在接口63.4.注冊接口73.5.登錄接口73.6.登出接口84.“個人中心”模塊84.1.獲取個人基本信息84.2.獲取個人詳情信息94.3.更改個人詳情信息94.4.更改個人密碼91. 概述1.1. 交互接口概述本文檔主要描述前端頁面和后臺功能交互的數(shù)據(jù)接口，是前端開發(fā)人員和后臺功能交互的主要規(guī)范參

2、考。數(shù)據(jù)交互以json格式返回，后臺用 PHP語言實現(xiàn)。包含的主要功能模塊有：用戶、產(chǎn)品、商戶、購物車等模塊。1.2. 接口清單模塊功能描述用戶手機檢查檢查用戶名的手機號是否注冊過用戶名檢察檢查用戶名是否可用登錄檢查是否可以登錄注冊實現(xiàn)注冊功能產(chǎn)品獲取產(chǎn)品列表獲取產(chǎn)品表中的某些數(shù)據(jù)產(chǎn)品詳細獲取某個產(chǎn)品數(shù)據(jù)搜索產(chǎn)品根據(jù)搜索條件查詢產(chǎn)品新聞獲取新聞列表獲取新聞表中的某些數(shù)據(jù)新聞詳細獲取某個新聞的數(shù)據(jù)購物車查詢購物車查詢某個用戶的購物車數(shù)據(jù)加入購物車將商品加入購物車刪除購物車刪除購物車中的某個商品更新購物車更新購物車中的數(shù)據(jù)2. 文檔說明2.1. 說明以下接口無特殊說明均可遵循本規(guī)范調(diào)用:2.1.1

3、. 參數(shù)語法【語法】: param 參數(shù)名稱:參數(shù)含義:類型:必選【解釋】: 參數(shù)名是傳遞給后端接口的重要數(shù)據(jù)，它一般用于后端根據(jù)前端的特殊需求返回不同的數(shù)據(jù)。它的命名規(guī)則一般但不僅限于如下規(guī)則，（有意義的單詞，單詞或者數(shù)字的組合）參數(shù)指定順序 名稱:參數(shù)的含義:類型:必選2.1.2. 返回值語法 result 返回值【解釋】:xz平臺將統(tǒng)一采用JSON字符串作為返回值。前端人員根據(jù)JSON的返回狀態(tài)確定本次數(shù)據(jù)獲取成功與否。成功將獲取如下格式數(shù)據(jù) code:200, msg:.失敗將返回如下數(shù)據(jù) code:201, msg:.2.2. 返回代碼含義錯誤代碼方便前端在調(diào)試和制作程序的過程中進行

4、調(diào)試code: 指定200:成功201:失敗401:對應(yīng)參數(shù)沒有傳遞500:數(shù)據(jù)庫錯誤3. “基本信息”模塊3.1. 用戶名是否存在接口URLdata/user/check_uname.php說明接收客戶端提交的uname，驗證此用戶名是否已經(jīng)存在請求類型POST或者GET請求參數(shù)paramuname：用戶名：字符類型 : 必選返回結(jié)果result形如： code:201,msg:exist，表示用戶名已經(jīng)存在或 code:200,msg:non-exist，表示用戶名不存在或 code:401,msg:uname required，表示參數(shù)沒有傳遞或 code:500, msg:db exe

5、cute err 表示數(shù)據(jù)庫執(zhí)行錯誤3.2. 郵箱是否存在接口URLdata/user/check_email.php說明接收客戶端提交的email，驗證此郵箱是否已經(jīng)存在。請求類型POST或者GET請求參數(shù)paramemail：郵箱：字符類型 : 必選返回結(jié)果result形如： code:201,msg:exist，表示郵箱已經(jīng)存在或 code:200,msg:non-exist，表示郵箱不存在或 code:401,msg:email required 表示郵箱參數(shù)沒有傳遞值或 code:500, msg:db execute err 表示數(shù)據(jù)庫錯誤3.3. 手機號是否存在接口URLdata

6、/user/check_phone.php說明接收客戶端提交的phone，驗證此電話號碼是否已經(jīng)存在。請求類型POST或者GET請求參數(shù)paramphone：手機號碼 : 字符類型 : 必選返回結(jié)果result形如： code:201,msg:exist，表示手機已經(jīng)存在或 code:200,msg:non-exist，表示手機不存在或 code:401,msg:email required 表示郵箱參數(shù)沒有傳遞值或 code:500, msg:db execute err 表示數(shù)據(jù)庫錯誤3.4. 注冊接口URLdata/user/register.php說明接收客戶端提交的登錄信息：name

7、、pwd，執(zhí)行登錄驗證請求類型POST或者GET請求參數(shù)paramuname :用戶名：字符類型paramupwd：密碼:字符類型paramemail:郵箱：字符類型paramphone:手機：字符類型返回結(jié)果result形如： code:200, msg:register succ, uid:12表示注冊成功或 code:401,msg:uname required 表示用戶性參數(shù)沒有傳遞或 code:402,msg:upwd required表示密碼參數(shù)沒有傳遞或 code:403,msg:email required表示郵箱參數(shù)沒有傳遞或 code:404,msg:phone requi

8、red表示電話號碼參數(shù)沒有傳遞或 code:500, msg:db execute err表示數(shù)據(jù)庫錯誤3.5. 登錄接口URLdata/user/login.php說明接收客戶端提交的登錄信息：name、pwd，執(zhí)行登錄驗證請求類型POST或者GET請求參數(shù)paramuname：用戶名：字符類型：必選paramupwd:密碼：字符類型：必選返回結(jié)果result形如： code:201, msg:uname or upwd err，表示失敗或 code:200, msg:login succ，表示失敗或 code:401,msg:uname required 表示用戶名沒有傳遞或 code:4

9、02,msg:upwd required 表示密碼沒有傳遞或 code:500, msg:db execute err 表示數(shù)據(jù)庫錯誤3.6. 登出接口URLdata/user/login.php說明退出登錄，銷毀用戶的所有登錄相關(guān)數(shù)據(jù)請求類型POST或者GET請求參數(shù)param無返回結(jié)果result形如： code:200, msg:logout succ，表示成功4. “個人中心”模塊4.1. 獲取個人基本信息URLdata/user/session_data.php說明返回當前登錄用戶的信息請求類型POST或者GET請求參數(shù)param無返回結(jié)果result形如： uid:1,uname:

10、dingding，表示用戶id和用戶名4.2. 獲取個人詳情信息URLdata/user/get_basic.php說明請求類型POST或者GET請求參數(shù)param無返回結(jié)果result形如：email:dang,phoneavatar:img/avatar/default.png,user_name:u6797u5f53,gender:1,code:200表示成功獲取或 code:401, msg:login required表示沒有登錄就請求本接口或 code:500, msg:db execute err表示數(shù)據(jù)庫錯誤或 code:501, msg:uid no

11、t exists表示此id無對應(yīng)用戶4.3. 更改個人詳情信息URLdata/user/update_basic.php說明修改用戶基本注冊信息請求類型POST或者GET請求參數(shù)paramuser_name:用戶名:字符串paramgender：性別：字符串paramphone:電話：字符串paramemail:郵箱:字符串返回結(jié)果result形如： code:201, msg:nothing updated，表示沒有更新或 code:200, msg:update succ，表示更新成功或 code:401,msg:login required表示沒有登錄或 code:500, msg:db

12、 execute err表示數(shù)據(jù)庫錯誤4.4. 更改個人密碼URLdata/user/update_password.php說明修改用戶密碼請求類型POST或者GET請求參數(shù)paramold_pwd:舊秘鑰:字符類型paramnew_pwd: 新秘鑰:字符類型返回結(jié)果result形如：code:201, msg:old password err，表示舊密碼無法匹配或 code:200, msg:update succ，表示更新成功或 code:401,msg:login required表示沒有登錄或 code:402,msg:old pwd required表示舊密碼參數(shù)沒有傳遞或 code

13、:403,msg:new pwd required表示新密碼參數(shù)沒有傳遞或 code:500, msg:db execute err 表示數(shù)據(jù)庫錯誤4.5. 更改個人頭像URLdata/user/ update_avatar.php說明修改用戶頭像請求類型POST或者GET請求參數(shù)param無返回結(jié)果result形如： code:201, msg:uid non-exists，表示沒有登錄或 code:200, msg:update succ，表示更新成功或 code:401,msg:login required表示沒有登錄或 code:500, msg:db execute err 表示數(shù)據(jù)

14、庫錯誤5. “商鋪中心”模塊5.1. 首頁列表URLdata/product/ index.php說明向首頁提供必需的數(shù)據(jù)，包括輪播廣告、首頁推薦、最新上架、熱銷單品請求類型POST或者GET請求參數(shù)param無返回結(jié)果result形如： carouselItems: , 獲取輪播廣告項 recommendedItems: , 首頁推薦商品 newArrialItems: , 最新上架商品 topSaleItems: 熱銷商品 返回的首頁數(shù)據(jù)5.2. 分頁列表URLdata/product/list.php說明分頁顯示所有的商品請求類型POST或者GET請求參數(shù)param無返回結(jié)果result

15、形如： code:500, msg:db execute err表示數(shù)據(jù)庫執(zhí)行錯誤或recordCount:43,pageSize:9,pageCount:5,pno:1,data:lid:1,title:Apple MacBook Air 13.3u82f1u5bf8u7b14u8bb0u672c u94f6u8272(Core i5 u5904u7406u5668/8GBu5185u5b58/128GB SSDu95eau5b58 MMGF2CH/A),price:6988.00,sold_count:2968,is_onsale:1,pic:img/product/md/57b12a31

16、N8f4f75a3.jpg,lid:27,title:u6234u5c14DELLu7075u8d8au6e38u532315PR-5645B 15.6u82f1u5bf8u6e38u620fu7b14u8bb0u672cu7535u8111(i5-7300HQ 8G 128GSSD+1T GTX1050 4Gu72ecu663e FHD)u9ed1,price:5999.00,sold_count:2110,is_onsale:0,pic:img/product/md/5913f8ffN49fa143c.jpg,lid:20,title:u6234u5c14DELLu7075u8d8au71

17、c37000 R1725G 14.0u82f1u5bf8u8f7bu8584u7a84u8fb9u6846u7b14u8bb0u672cu7535u8111(i7-7500U 8G 128GSSD+1T 940MX 2Gu72ecu663e FHD)u91d1,price:6599.00,sold_count:1930,is_onsale:1,pic:img/product/md/57bbc38eN9def8042.jpg,lid:2,title:Apple MacBook Air 13.3u82f1u5bf8u7b14u8bb0u672c u94f6u8272(Core i5 u5904u7

18、406u5668/8GBu5185u5b58/256GB SSDu95eau5b58 MMGG2CH/A),price:8268.00,sold_count:1922,is_onsale:0,pic:img/product/md/57b12a31N8f4f75a3.jpg,lid:22,title:u6234u5c14DELLu7075u8d8au6e38u532315PR-5745B 15.6u82f1u5bf8u6e38u620fu7b14u8bb0u672cu7535u8111(i7-7700HQ 8G 128GSSD+1T GTX1050 4Gu72ecu663e FHD)u9ed1,

19、price:6999.00,sold_count:1901,is_onsale:1,pic:img/product/md/5913f8ffN49fa143c.jpg,lid:29,title:u8054u60f3(ThinkPad)u8f7bu8584u7cfbu5217E470c(20H3A004CD)14u82f1u5bf8u7b14u8bb0u672cu7535u8111(i5-6200U 8G 500G 2Gu72ecu663e Win10)u9ed1u8272,price:4699.00,sold_count:1862,is_onsale:0,pic:img/product/md/584b5678Nbc9f1e70.jpg,lid:43,title:u795eu821f(HASEE)u6218u795eZ6-KP7GT 15.6u82f1u5bf8u6e38u62