服務(wù)器信息

IP：192.168.0.108

Port：9000

云服務(wù)器信息

IP：43.142.28.161

端口：9000

狀態(tài)碼

狀態(tài)碼備注

200	請(qǐng)求成功
500	服務(wù)器端響應(yīng)失敗
401	前端傳參為空或空串
402	賬號(hào)或密碼錯(cuò)誤
501	若賬號(hào)已存在，以改賬號(hào)注冊(cè)返回501
502	身份驗(yàn)證失敗

登錄/注冊(cè)模塊

用戶(hù)注冊(cè)接口

注冊(cè)頁(yè)接口

• URL：http://IP:Port/xdmall/user/logon

• 請(qǐng)求方式：POST

• Request Body：

  屬性名類(lèi)型必填備注

  accountNum	string	是	-
  password	string	是	-
  role	string	是	取值user/business/admin之一

• 示例

  //request {"accountNum":"835629801@user","password":"a1b2c3","role":"user" }//response {"data": {"role": "user","accountNum": "835629801@user"},"msg": "logon success.","code": 200 }--------------------------- //賬號(hào)已存在，注冊(cè)失敗 {"data": null,"msg": "Account already exists","code": 501 }//缺少參數(shù) {"data": null,"msg": "param is null.","code": 401 }

用戶(hù)登錄接口

登錄頁(yè)接口

• URL：http://IP:Port/xdmall/user/login

• 請(qǐng)求方式：POST

• Request Body：

  屬性名類(lèi)型必填備注

  accountNum	string	是	-
  password	string	是	-
  role	string	是	取值user/business/admin之一

• 示例

  //request {"accountNum":"835629801@user","password":"a1b2c3","role":"user" }//response {"data": {"image": “頭像的base64編碼","role": "user","accountNum": "835629801@user"},"msg": "login success.","code": 200 }---------------------------- //賬號(hào)不存在 {"data": null,"msg": "user is not exists.","code": 402 }//密碼錯(cuò)誤 {"data": null,"msg": "password error.","code": 402 }//缺少參數(shù) {"data": null,"msg": "param is null.","code": 401 }

用戶(hù)信息修改接口

• URL：http://IP:Port/xdmall/user/alterUser

• 請(qǐng)求方式：POST

• Request Body：

  屬性名類(lèi)型必填備注

  accountNum	string	是	根據(jù)用戶(hù)賬號(hào)修改信息
  password	string	否	-
  nickname	string	否	-
  pic	string	否	-
  sex	string	否	男/女
  tel	string	否	-
  isVip	bool	否	-

  • 注：需要修改那個(gè)屬性，json就傳那個(gè)key，value

• 示例

  request body {"accountNum":"835629801@business","password":"a1b2c3","nickname":"初陽(yáng)尋風(fēng)","pic":"base64","sex":"男","tel":"15399413267","isVip":true }response {"data": null,"msg": "success.","code": 200 }

商戶(hù)信息修改接口

• URL：http://IP:Port/xdmall/user/alterBusiness

• 請(qǐng)求方式：POST

• Request Body：

  屬性名類(lèi)型必填備注

  storeName	string	否	-
  owner	string	是	根據(jù)owner查找該賬號(hào)下商店
  pic	string	否	-
  address	string	否	-
  zipcode	string	否	-
  tel	string	否	-
  type	string	否	-
  level	int	否	-

  • 注：需要修改那個(gè)屬性，json就傳那個(gè)key，value

• 示例

  request body {"storeName":"黑豬白豬的小店","owner":"835629801@business","pic":"","address":"陜西省西安市蓮湖區(qū)紅廟坡街道","zipcode":"710014","tel":"15399413267","type":"花店","level":5 }response {"data": null,"msg": "success.","code": 200 }

管理員信息修改接口

• URL：http://IP:Port/xdmall/user/alterAdmin

• 請(qǐng)求方式：POST

• Request Body：

  屬性名類(lèi)型必填備注

  accountNum	string	是	根據(jù)賬號(hào)修改信息
  adminName	string	否	-
  pic	string	否	-
  tel	string	否	-

  • 注：需要修改那個(gè)屬性，json就傳那個(gè)key，value

• 示例

  request body {"accountNum":"835629801@business","adminName":"黑豬","pic":"","tel":"15399413267" }response {"data": null,"msg": "success.","code": 200 }

用戶(hù)/商戶(hù)信息查詢(xún)

• URL：http://IP:Port/xdmall/user/query

• 請(qǐng)求方式：GET

• Request Param：

  屬性名類(lèi)型必填備注

  accountNum	string	是	-
  role	string	是	-

• 示例

  request body http://localhost:9000/xdmall/user/query?accountNum=835629801@business&role=businessresponse {"data": {"id": 1,"storeName": "黑豬白豬的小店","owner": "835629801@business","pic": "用戶(hù)頭像base64編碼","address": "陜西省西安市蓮湖區(qū)紅廟坡街道","zipcode": "710014","tel": "15399413267","type": "花店","level": 5,"picturePath": "", //忽略該字段"role": "business"},"msg": "success.","code": 200 }

商品模塊

商戶(hù)添加商品接口

商戶(hù)權(quán)限下，添加商品接口。注：添加商品要先對(duì)商戶(hù)信息進(jìn)行初始化，否則商戶(hù)名為默認(rèn)值：未設(shè)置

• URL：http://IP:Port/xdmall/product/add

• 請(qǐng)求方式：POST

• Request Body：

  屬性名類(lèi)型必填備注

  accountNum	string	是	-
  role	string	是	只有business角色能添加商品
  product	object	是	商品對(duì)象，字段詳情見(jiàn)示例

• 示例

request {"accountNum": "835629801@business", //登錄賬戶(hù)"role": "business", //登錄角色"product": {"name": "小米8 全面屏游戲智能手機(jī) 6GB+64GB 黑色 全網(wǎng)通4G 雙卡雙待", //商品名稱(chēng)"storeName": "黑豬白豬的小店", //商店名"pic": "", //商品圖片的base64編碼"brand": "小米", //品牌"price": 2699.00, //價(jià)格，單位:元"description": "驍龍845處理器，紅外人臉解鎖，AI變焦雙攝，AI語(yǔ)音助手小米6X低至1299，點(diǎn)擊搶購(gòu)", //商品描述"number": 30, //商品庫(kù)存數(shù)量"unit": "部", //單位"weight": 550.53, //重量，單位為克：g"keywords": "小米8 全面屏游戲智能手機(jī) 6GB+64GB 黑色 全網(wǎng)通4G 雙卡雙待" //關(guān)鍵詞，用于搜索} }response {"data": {"id": 17},"msg": "add product success.","code": 200 }

商戶(hù)/管理員刪除商品接口

商戶(hù)、管理員權(quán)限下，刪除商品接口

• URL：http://IP:Port/xdmall/product/drop

• 請(qǐng)求方式：POST

• Request Body：

  屬性名類(lèi)型必填備注

  accountNum	string	是	-
  role	string	是	只有business、admin角色能添刪除商品
  product	object	是	商品對(duì)象，字段詳情見(jiàn)示例

• 示例

request {"accountNum": "835629801@business","role": "business","product": {"id":"13"} }response {"data": null,"msg": "delete success.","code": 200 }

商戶(hù)/管理員/用戶(hù)根據(jù)商品ID查詢(xún)商品詳情接口

商戶(hù)、管理員、用戶(hù)權(quán)限下，查詢(xún)商品詳情接口。注意是精確查詢(xún)，主要針對(duì)商品CURD使用

• URL：http://IP:Port/xdmall/product/queryById

• 請(qǐng)求方式：POST

• Request Body：

  屬性名類(lèi)型必填備注

  accountNum	string	是	-
  role	string	是	user、business、admin角色具有接口權(quán)限
  product	object	是	商品對(duì)象，字段詳情見(jiàn)示例

• 示例

request {"accountNum": "835629801@business","role": "business","product": {"id":"12"} }response {"data": {"keywords": "蘋(píng)果|ipone|高端手機(jī)","price": 6000.50,"name": "ipone14","storeName":"黑豬白豬的小店","description": "蘋(píng)果手機(jī)..","weight": 500.23,"id": 12,"pic":"圖片base64編碼","stock": 20,"unit": "部","brand": "蘋(píng)果"},"msg": "query success.","code": 200 }

商戶(hù)修改商品接口

商戶(hù)權(quán)限下，修改商戶(hù)自身商品信息接口

• URL：http://IP:Port/xdmall/product/alterById

• 請(qǐng)求方式：POST

• Request Body：

  屬性名類(lèi)型必填備注

  accountNum	string	是	-
  role	string	是	business角色具有接口權(quán)限
  product	object	是	商品對(duì)象，字段詳情見(jiàn)示例

• 示例

request {"accountNum": "","role": "","product": {"id":12, //商品ID"name": "ipone14", //商品名稱(chēng)"storeName":"黑豬白豬的小店", //商店名"pic": "base64", //商品圖片"brand": "蘋(píng)果", //品牌"price": 6000.00, //價(jià)格，單位:元"description": "蘋(píng)果手機(jī)..", //商品描述"number": 20, //商品數(shù)量，增加20為20，減少10為-10"unit": "部", //單位"weight": 500.00, //重量，單位為克：g"keywords": "蘋(píng)果|ipone|高端手機(jī)" //關(guān)鍵詞，用于搜索} }response {"data": null,"msg": "alter product success.","code": 200 }

批量查詢(xún)商品接口

商戶(hù)權(quán)限下，修改商戶(hù)自身商品信息接口

• URL：http://IP:Port/xdmall/product/query/batch

• 請(qǐng)求方式：GET

• Request Param：

  屬性名類(lèi)型必填備注

  pageNum	int	否	頁(yè)數(shù)，默認(rèn)1，第一頁(yè)為1
  pageSize	int	否	頁(yè)大小，默認(rèn)10
  storeName	string	否	商店名，如果為空，表示查詢(xún)所有商戶(hù)下所有商品

• 示例

request http://localhost:9000/xdmall/product/query/batch?pageNum=1&pageSize=5&storeName=黑豬白豬的小店response {"data": {"total": 1, //當(dāng)前查詢(xún)條件下商品總數(shù)"content": [{"id": 3,"name": "小米8 全面屏游戲智能手機(jī) 6GB+64GB 黑色 全網(wǎng)通4G 雙卡雙待","storeName": "黑豬白豬的小店","pic": "商品圖片base64編碼","brand": "小米","price": 2699.0,"description": "驍龍845處理器，紅外人臉解鎖，AI變焦雙攝，AI語(yǔ)音助手小米6X低至1299，點(diǎn)擊搶購(gòu)","number": 0,"stock": 30,"unit": "部","weight": 550.53,"keywords": "小米8 全面屏游戲智能手機(jī) 6GB+64GB 黑色 全網(wǎng)通4G 雙卡雙待","picturePath": "" //忽略該字段}]},"msg": "success.","code": 200 }

搜索模塊

將數(shù)據(jù)庫(kù)中數(shù)據(jù)導(dǎo)入到Elasticsearch

將數(shù)據(jù)庫(kù)中所有數(shù)據(jù)導(dǎo)入ES

• URL：http://IP:Port/xdmall/esProduct/importAll

• 請(qǐng)求方式：POST

• Request Body：無(wú)

• 示例

requestresponse {"data": 3, //返回導(dǎo)入記錄條數(shù)"msg": "success.","code": 200 }

根據(jù)商品ID導(dǎo)入商品到ES

根據(jù)商品ID將商品導(dǎo)入ES，商品添加成功后后端調(diào)用

• URL：http://IP:Port/xdmall/esProduct/import/{id}
• 請(qǐng)求方式：POST
• Request Body：無(wú)
• 示例

http://192.168.0.108:9000/xdmall/esProduct//import/16{"data": {"id": 16,"name": "華為 HUAWEI P20 ","pic": null,"brand": "華為","price": 3788.0,"description": "AI智慧全面屏 6GB +64GB 亮黑色 全網(wǎng)通版 移動(dòng)聯(lián)通電信4G手機(jī) 雙卡雙待手機(jī) 雙卡雙待","number": 0,"stock": 20,"unit": "部","weight": 500.5,"keywords": "華為|全面屏|高端手機(jī)|全網(wǎng)通版|雙卡雙待","picturePath": "F:\\compute\\Java學(xué)習(xí)\\IdeaProjects\\netmarket\\image\\product\\cOnt1rDlnH.jpg"},"msg": "success.","code": 200 }

根據(jù)商品ID刪除ES中記錄

根據(jù)商品ID刪除ES中記錄，商品刪除成功后后端調(diào)用

• URL：http://IP:Port/xdmall/esProduct/delete/{id}
• 請(qǐng)求方式：GET
• Request Param：無(wú)
• 示例

http://192.168.0.108:9000/xdmall/esProduct/delete/16{"data": null,"msg": "success.","code": 200 }

批量刪除ES商品記錄

根據(jù)商品ID批量刪除ES中記錄

• URL：http://IP:Port/xdmall/esProduct/delete/batch
• 請(qǐng)求方式：POST
• Request Param：無(wú)
• 示例

http://192.168.0.108:9000/xdmall/esProduct/delete/batch?ids=16,17{"data": null,"msg": "success.","code": 200 }

ES搜索接口

聯(lián)想搜索相關(guān)接口，可以用于首頁(yè)搜索框，商品類(lèi)別等…

• URL：http://IP:Port/xdmall/esProduct//search/simple

• 請(qǐng)求方式：GET

• Request Param：

  屬性名類(lèi)型必填備注

  accountNum	string	是	記錄用戶(hù)搜索歷史，用于首頁(yè)商品推薦，搜索歷史保留1年
  keyword	string	是	關(guān)鍵詞，根據(jù)商品名、描述、關(guān)鍵詞字段進(jìn)行分詞并查詢(xún)
  pageNum	number	否	默認(rèn)1，第一頁(yè)的頁(yè)號(hào)為1
  pageSize	number	否	默認(rèn)5

• 示例

http://192.168.0.108:9000/xdmall/esProduct/search/simple?keyword=手機(jī)&pageNum=0&pageSize=2{"data": {"total": 2,"content": [{"id": 15,"name": "ipone14","pic": "商品圖片base64編碼","brand": "蘋(píng)果","price": 6000.5,"description": "蘋(píng)果手機(jī)..","number": 0, //忽略該字段"stock": 20, //展示庫(kù)存"unit": "部","weight": 500.23,"keywords": "蘋(píng)果|ipone|高端手機(jī)","picturePath": ""},{"id": 16,"name": "華為 HUAWEI P20 ","pic": "商品圖片base64編碼","brand": "華為","price": 3788.0,"description": "AI智慧全面屏 6GB +64GB 亮黑色 全網(wǎng)通版 移動(dòng)聯(lián)通電信4G手機(jī) 雙卡雙待手機(jī) 雙卡雙待","number": 0,"stock": 20,"unit": "部","weight": 500.5,"keywords": "華為|全面屏|高端手機(jī)|全網(wǎng)通版|雙卡雙待","picturePath": ""}]},"msg": "success.","code": 200 }

商品推薦接口

根據(jù)用戶(hù)歷史搜索記錄進(jìn)行首頁(yè)商品推薦，返回10款商品

• URL：http://IP:Port/xdmall/esProduct//search/recommend

• 請(qǐng)求方式：GET

• Request Param：

  屬性名類(lèi)型必填備注

  accountNum	string	是	記錄用戶(hù)搜索歷史，用于首頁(yè)商品推薦，
  pageNum	number	否	默認(rèn)1，第一頁(yè)的頁(yè)號(hào)為1
  pageSize	number	否	默認(rèn)5

• 示例

  http://192.168.0.108:9000/xdmall/esProduct/search/recommend?accountNum=835629801@business{"data": [{"id": 15,"name": "ipone14","pic": "商品圖片base64編碼","brand": "蘋(píng)果","price": 6000.5,"description": "蘋(píng)果手機(jī)..","number": 0, //忽略該字段"stock": 20, //展示庫(kù)存"unit": "部","weight": 500.23,"keywords": "蘋(píng)果|ipone|高端手機(jī)","picturePath": ""},{"id": 16,"name": "華為 HUAWEI P20 ","pic": "商品圖片base64編碼","brand": "華為","price": 3788.0,"description": "AI智慧全面屏 6GB +64GB 亮黑色 全網(wǎng)通版 移動(dòng)聯(lián)通電信4G手機(jī) 雙卡雙待手機(jī) 雙卡雙待","number": 0,"stock": 20,"unit": "部","weight": 500.5,"keywords": "華為|全面屏|高端手機(jī)|全網(wǎng)通版|雙卡雙待","picturePath": ""}],"msg": "success.","code": 200 }

購(gòu)物車(chē)模塊

添加購(gòu)物車(chē)商品

• URL：http://IP:Port/xdmall/shopping/add

• 請(qǐng)求方式：POST

• Request Body：

  屬性名類(lèi)型必填備注

  accountNum	string	是	-
  productId	number	是	商品ID
  number	number	是	商品數(shù)量

• 示例

  request body {"accountNum": "835629801@user","productId": 3,"number": 1 }response {"data": {"id": 2 //購(gòu)物車(chē)中記錄ID},"msg": "success.","code": 200 }

修改購(gòu)物車(chē)商品數(shù)量

• URL：http://IP:Port/xdmall/shopping/alter

• 請(qǐng)求方式：POST

• Request Body：

  屬性名類(lèi)型必填備注

  accountNum	string	是	-
  id	number	是	購(gòu)物車(chē)記錄ID
  number	number	是	商品數(shù)量

• 示例

  request body {"accountNum": "835629801@user","id": 2,"number": 2 }response {"data": null,"msg": "success.","code": 200 }

查詢(xún)賬戶(hù)下購(gòu)物車(chē)信息

• URL：http://IP:Port/xdmall/shopping/query

• 請(qǐng)求方式：GET

• Request Param：

  屬性名類(lèi)型必填備注

  accountNum	string	是	查找某賬戶(hù)下購(gòu)物車(chē)信息

• 示例

  request param http://localhost:9000/xdmall/shopping/query?accountNum=835629801@userresponse {"data": [{"product": { //商品信息"id": 3,"name": "小米8 全面屏游戲智能手機(jī) 6GB+64GB 黑色 全網(wǎng)通4G 雙卡雙待","storeName": "黑豬白豬的小店","pic": "商品圖片base64編碼","brand": "小米","price": 2699.0,"description": "驍龍845處理器，紅外人臉解鎖，AI變焦雙攝，AI語(yǔ)音助手小米6X低至1299，點(diǎn)擊搶購(gòu)","number": 0,"stock": 30,"unit": "部","weight": 550.53,"keywords": "小米8 全面屏游戲智能手機(jī) 6GB+64GB 黑色 全網(wǎng)通4G 雙卡雙待","picturePath": "" //忽略該字段},"number": 2, //購(gòu)物車(chē)商品數(shù)量"accountNum": "835629801@user","id": 2 //購(gòu)物車(chē)記錄ID}],"msg": "success.","code": 200 }

刪除購(gòu)物車(chē)商品

• URL：http://IP:Port/xdmall/shopping/drop

• 請(qǐng)求方式：GET

• Request Param：

  屬性名類(lèi)型必填備注

  id	number	是	購(gòu)物車(chē)記錄ID

• 示例

  request http://localhost:9000/xdmall/shopping/drop?id=1response {"data": null,"msg": "success.","code": 200 }

訂單模塊

添加訂單

• URL：http://IP:Port/xdmall/order/add

• 請(qǐng)求方式：POST

• Request Body：

  屬性名類(lèi)型必填備注

  accountNum	string	是	賬戶(hù)
  state	string	是	訂單狀態(tài)，create、run、done
  shoppingId	string	是	購(gòu)物車(chē)ID組合，如2|3表示該訂單由購(gòu)物車(chē)單號(hào)2，3組成

• 示例

  request body {"accountNum":"835629801@user","state":"create","shoppingId":"2" }response {"data": {"id": 2 //訂單ID},"msg": "success.","code": 200 }

修改訂單狀態(tài)

• URL：http://IP:Port/xdmall/order/alter

• 請(qǐng)求方式：POST

• Request Body：

  屬性名類(lèi)型必填備注

  id	string	是	訂單ID
  state	string	是	訂單狀態(tài)，create、run、done

• 示例

  request body {"id":"1","state":"done" }response {"data": null,"msg": "success.","code": 200 }

查詢(xún)賬戶(hù)下所有訂單

• URL：http://IP:Port/xdmall/order/query

• 請(qǐng)求方式：GET

• Request Param：

  屬性名類(lèi)型必填備注

  accountNum	string	是	賬戶(hù)

• 示例

  request http://localhost:9000/xdmall/order/query?accountNum=835629801@userresponse {"data": [{"id": 1, //訂單編號(hào)"accountNum": "835629801@user", //訂單所屬賬戶(hù)"createtime": "2023-06-04 20:51:23", //訂單創(chuàng)建時(shí)間"address": "陜西省西安市蓮湖區(qū)紅廟坡街道紅東花園1期", //訂單收貨地址"state": "done", //訂單狀態(tài)"price": 10796.00, //訂單中商品總額"productAndNumDtoList": [ //訂單由若干商品組成，且包含商品數(shù)量{"number": 2, //商品數(shù)量"product": { //商品信息"id": 3,"name": "小米8 全面屏游戲智能手機(jī) 6GB+64GB 黑色 全網(wǎng)通4G 雙卡雙待","storeName": "黑豬白豬的小店","pic": "商品base64編碼""brand": "小米","price": 2699.0,"description": "驍龍845處理器，紅外人臉解鎖，AI變焦雙攝，AI語(yǔ)音助手小米6X低至1299，點(diǎn)擊搶購(gòu)","number": 0,"stock": 30,"unit": "部","weight": 550.53,"keywords": "小米8 全面屏游戲智能手機(jī) 6GB+64GB 黑色 全網(wǎng)通4G 雙卡雙待","picturePath": ""}},{"number": 2, //商品數(shù)量"product": { //商品信息"id": 4,"name": "小米8 全面屏游戲智能手機(jī) 6GB+64GB 黑色 全網(wǎng)通4G 雙卡雙待","storeName": "黑豬白豬的小店","pic": "商品base64編碼""brand": "小米","price": 2699.0,"description": "驍龍845處理器，紅外人臉解鎖，AI變焦雙攝，AI語(yǔ)音助手小米6X低至1299，點(diǎn)擊搶購(gòu)","number": 0,"stock": 30,"unit": "部","weight": 550.53,"keywords": "小米8 全面屏游戲智能手機(jī) 6GB+64GB 黑色 全網(wǎng)通4G 雙卡雙待","picturePath": ""}}]},{"id": 2, //同上，第二個(gè)訂單"accountNum": "835629801@user","createtime": "2023-06-04 21:03:06","address": "陜西省西安市蓮湖區(qū)紅廟坡街道紅東花園1期","state": "create","price": 5398.00,"productAndNumDtoList": [{"number": 2,"product": {"id": 3,"name": "小米8 全面屏游戲智能手機(jī) 6GB+64GB 黑色 全網(wǎng)通4G 雙卡雙待","storeName": "黑豬白豬的小店","pic": "商品base64編碼""brand": "小米","price": 2699.0,"description": "驍龍845處理器，紅外人臉解鎖，AI變焦雙攝，AI語(yǔ)音助手小米6X低至1299，點(diǎn)擊搶購(gòu)","number": 0,"stock": 30,"unit": "部","weight": 550.53,"keywords": "小米8 全面屏游戲智能手機(jī) 6GB+64GB 黑色 全網(wǎng)通4G 雙卡雙待","picturePath": ""}}]}],"msg": "success.","code": 200 }

總結(jié)

以上是生活随笔為你收集整理的电商项目前后端接口说明的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。