# MyPetStoreFrontPart **Repository Path**: geek-code-23/my-pet-store-front-part ## Basic Information - **Project Name**: MyPetStoreFrontPart - **Description**: mypetstore前端 - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2022-04-06 - **Last Updated**: 2022-06-06 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # mypetstore-api接口文档 ## Catalog ### 1.获取所有Category **Request** - Method: **GET** - URL: **/catalog/categories** - Parameters: ``` ``` **Response** - fail ``` { "status": 1, "msg": "服务器异常" } ``` - success ``` { "status": 0, "data": [ { "categoryId": "BIRDS", "name": "Birds", "description": " Birds" }, { "categoryId": "CATS", "name": "Cats", "description": " Cats" }， ... ] } ``` ------- ### 2.获取单个Category **Request** - Method: **GET** - URL: **/catalog/categories/{id}** - Parameters: ``` ``` **Response** - fail ``` { "status": 1, "msg": "服务器异常" } ``` - success ``` { "status": 0, "data": { "name": "Dogs", "description": " Dogs", "categoryId": "DOGS" } } ``` ------- ### 3.获取某个Category分类下的所有Product信息 **Request** - Method: **GET** - URL: **/catalog/categories/{id}/products** - Parameters: ``` ``` **Response** - fail ``` { "status": 1, "msg": "服务器异常" } ``` - success ``` { "status": 0, "data": [ { "productId": "K9-BD-01", "categoryId": "DOGS", "name": "Bulldog", "description": "Friendly dog from England", "image": "../images/dog2.gif" }, //... ] } ``` ------- ### 4.获取单个Product小分类的信息 **Request** - Method: **GET** - URL: **/catalog/products/{id}** - Parameters: ``` ``` **Response** - fail ``` { "status": 1, "msg": "服务器异常" } ``` - success ``` { "status": 0, "data": { "productId": "AV-CB-01", "categoryId": "BIRDS", "name": "Amazon Parrot", "description": "Great companion for 75 years", "image": "../images/bird2.gif" } } ``` ------- ### 5.获取某个Product分类下的所有Item信息 **Request** - Method: **GET** - URL: **/catalog/products/{id}/items** - Parameters: ``` ``` **Response** - fail ``` { "status": 1, "msg": "服务器异常" } ``` - success ``` { "status": 0, "data": [ { "itemId": "EST-20", "productId": "FI-FW-02", "listPrice": 5.50, "unitCost": 2.00, "supplierId": 1, "status": "P", "attribute1": "Adult Male", "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "categoryId": "FISH", "name": "Goldfish", "description": "Fresh Water fish from China", "image": "../images/fish2.gif", "quantity": 10000 }, //... ] } ``` ------- ### 6.获取单个Item商品的信息 **Request** - Method: **GET** - URL: **/catalog/items/{id}** - Parameters: ``` ``` **Response** - fail ``` { "status": 1, "msg": "服务器异常" } ``` - success ``` { "status": 0, "data": { "itemId": "EST-10", "productId": "K9-DL-01", "listPrice": 18.50, "unitCost": 12.00, "supplierId": 2, "status": "P", "attribute1": "Spotted Adult Female", "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "categoryId": "DOGS", "name": "Dalmation", "description": "Great dog for a Fire Station", "image": "../images/dog5.gif", "quantity": 10000 } } ``` --------- ### 7.获取搜索的Product **Request** - Method: **GET** - URL: **/catalog/products/search** - Parameters: ``` { keywords: 'a' } ``` **Response** - fail ``` { "status": 1, "msg": "服务器异常" } ``` - success ``` { "status": 0, "data": [ { "productId": "AV-CB-01", "categoryId": "BIRDS", "name": "Amazon Parrot", "description": "Great companion for 75 years", "image": "../images/bird2.gif" }, { "productId": "FI-SW-01", "categoryId": "FISH", "name": "Angelfish", "description": "Salt Water fish from Australia", "image": "../images/fish1.gif" }, //... ] } ``` ------- ## Account ### 1.账号密码登录 **Request** - Method: **POST** - URL: /user/login - Parameters: ``` { username: "aaa", password: "123", code: "1234" } ``` **Response** - fail ``` { "status": 1, "msg": "用户名或密码不正确" } { "status": 101, "msg": "验证码错误！" } ``` - success ``` { "status": 0, "data": { "username": "aaa", "email": "123456@qq.com", "firstName": "张", "lastName": "三", "status": null, "address1": "CS", "address2": "CSU", "city": "CS", "state": "HN", "zip": "123456", "country": "CN", "phone": "13213761071", "favouriteCategoryId": "DOGS", "languagePreference": "English", "listOption": true, "bannerOption": true, "bannerName": "" } } ``` ----- ### 2.注册 **Request** - Method: **POST** - URL: /user/register - Parameters: ``` { username: "aaa", password: "123", code: "1234" } ``` **Response** - fail ``` { "status": 1, "msg": "用户名已存在" } { "status": 101, "msg": "验证码错误！" } ``` - success ``` { "status": 0, "data": { "username": "aaa", "email": null, "firstName": null, "lastName": null, "status": null, "address1": null, "address2": null, "city": null, "state": null, "zip": null, "country": null, "phone": null, "favouriteCategoryId": null, "languagePreference": null, "listOption": false, "bannerOption": false, "bannerName": null } } ``` ----- ### 3.获取验证码图片 **Request** - Method: **无** - URL: /user/kaptcha - Parameters: ``` ``` **Response** - fail ``` ``` - success ``` ``` ------- ### 4.获取手机验证码 **Request** - Method: **POST** - URL: /user/phoneCode - Parameters: ``` { phoneNumber: "13213761071" } ``` **Response** - fail ``` { "status": 101, "msg": "发送验证码失败！" } ``` - success ``` { "status": 0, "msg":"已成功发送验证码！" } ``` ------ ### 5.手机验证码登录 **Request** - Method: **POST** - URL: /user/phoneLogin - Parameters: ``` { phoneNumber: "13213761071", phoneCode: "90987" } ``` **Response** - fail ``` { "status": 1, "msg": "系统异常！" } { "status": 1, "msg": "用户不存在！" } { "status": 101, "msg": "验证码错误！" } ``` - success ``` { "status": 0, "data": { "username": "aaa", "email": "123456@qq.com", "firstName": "张", "lastName": "三", "status": null, "address1": "CS", "address2": "CSU", "city": "CS", "state": "HN", "zip": "123456", "country": "CN", "phone": "13213761071", "favouriteCategoryId": "DOGS", "languagePreference": "English", "listOption": true, "bannerOption": true, "bannerName": "" } } ``` ----- ### 6.查看已登录账号信息 **Request** - Method: **POST** - URL: /user/get_login_account_info - Parameters: ``` ``` **Response** - fail ``` { "status": 1, "msg": "服务器异常！" } { "status": 11, "msg": "未登录！" } ``` - success ``` { "status": 0, "data": { "username": "aaa", "email": null, "firstName": null, "lastName": null, "status": null, "address1": null, "address2": null, "city": null, "state": null, "zip": null, "country": null, "phone": null, "favouriteCategoryId": null, "languagePreference": null, "listOption": false, "bannerOption": false, "bannerName": null } } ``` ----- ### 7.更改已登录账号信息 **Request** - Method: **POST** - URL: /user/update_account - Parameters: ``` { firstName: "张", lastName: "三", email: "123456@qq.com", phone: null, address1: null, address2: null, city: null, state: null, zip: null, country: null, languagePreference: null, favouriteCategoryId: null, listOption: false, bannerOption: false } ``` **Response** - fail ``` { "status": 10, "msg": "请先登录！" } ``` - success ``` { "status": 0, "data": { "username": "aaa", "email": "123@qq.com", "firstName": "张", "lastName": "三", "status": null, "address1": null, "address2": null, "city": null, "state": null, "zip": null, "country": null, "phone": null, "favouriteCategoryId": null, "languagePreference": null, "listOption": false, "bannerOption": false, "bannerName": null } } ``` ----- ### 8.判断用户名 **Request** - Method: **POST** - URL: /user/username - Parameters: ``` { username: "aaa" } ``` **Response** - fail ``` { "status": 1, "msg": "用户名不存在" } ``` - success ``` { "status": 0, "data": { "username": "aaa", "email": null, "firstName": null, "lastName": null, "status": null, "address1": null, "address2": null, "city": null, "state": null, "zip": null, "country": null, "phone": null, "favouriteCategoryId": null, "languagePreference": null, "listOption": false, "bannerOption": false, "bannerName": null } } ``` ----- ### 9.退出已登录的账号 **Request** - Method: **POST** - URL: /user/sign_out - Parameters: ``` ``` **Response** - fail ``` { "status": 1, "msg": "请先登录！" } ``` - success ``` { "status": 0, "msg": "退出成功！" } ``` ------- ## Cart ### 1.获取已登录账号的Cart **Request** - Method: **GET** - URL: **/cart/myCart** - Parameters: ``` ``` **Response** - fail ``` { "status": 1, "msg": "请先登录！" } ``` - success ``` { "status": 0, "data": { "itemList": [ { "itemId": "EST-14", "productId": "FL-DSH-01", "descn": "Tailless Manx", "inStock": true, "quantity": 2, "listPrice": 58.50, "totalPrice": 117.00, "buyerName": "aaa" }, { "itemId": "EST-13", "productId": "RP-LI-02", "descn": "Green Adult Iguana", "inStock": true, "quantity": 2, "listPrice": 18.50, "totalPrice": 37.00, "buyerName": "aaa" } ] } } ``` ------- ### 2.向已登录账号的购物车添加商品 **Request** - Method: **POST** - URL: **/cart/myCart** - Parameters: ``` { itemId: "EST-14" } ``` **Response** - fail ``` { "status": 10, "msg": "请先登录！" } ``` - success ``` { "status": 0, "data": { "itemList": [ { "itemId": "EST-14", "productId": "FL-DSH-01", "descn": "Tailless Manx", "inStock": true, "quantity": 7, "listPrice": 58.50, "totalPrice": 117.00, "buyerName": "aaa" }, { "itemId": "EST-13", "productId": "RP-LI-02", "descn": "Green Adult Iguana", "inStock": true, "quantity": 2, "listPrice": 18.50, "totalPrice": 37.00, "buyerName": "aaa" } ] } } ``` ------- ### 3.移除已登录账号购物车中被选中的商品 **Request** - Method: **DELETE** - URL: **/cart/myCart/cartItems** - Parameters: ``` { itemId: "EST-14" } ``` **Response** - fail ``` { "status": 10, "msg": "请先登录！" } ``` ``` { "status": 1, "msg": "购物车中没有该商品!" } ``` - success ``` { "status": 0, "data": { "itemList": [ { "itemId": "EST-13", "productId": "RP-LI-02", "descn": "Green Adult Iguana", "inStock": true, "quantity": 2, "listPrice": 18.50, "totalPrice": 37.00, "buyerName": "aaa" } ] } } ``` ------- ### 4.更新已登录账号购物车中商品的数量 **Request** - Method: **POST** - URL: **/cart/myCart/cartItems** - Parameters: ``` { itemId: "EST-13", quantity: 100 //请确保quantity是自然数 } ``` **Response** - fail ``` { "status": 10, "msg": "请先登录！" } ``` ``` { "status": 1, "msg": "购物车中没有该商品!" } ``` - success ``` { "status": 0, "data": { "itemList": [ { "itemId": "EST-13", "productId": "RP-LI-02", "descn": "Friendly green friend", "inStock": true, "quantity": 100, "listPrice": 18.50, "totalPrice": 18.50, "buyerName": "aaa" }, { "itemId": "EST-14", "productId": "FL-DSH-01", "descn": "Great for reducing mouse populations", "inStock": true, "quantity": 2, "listPrice": 58.50, "totalPrice": 58.50, "buyerName": "aaa" } ] } } ``` ------- ### 5.购物车商品全选或全不选 **Request** - Method: **POST** - URL: **/cart/myCart/checkAll** - Parameters: ``` { checked: true } ``` **Response** - fail ``` { "status": 10, "msg": "请先登录！" } ``` ``` { "status": 1, "msg": "购物车中没有商品!" } ``` - success ``` { "status":0, "data":{ "itemList":[ { "itemId":"EST-18", "productId":"AV-CB-01", "image":"../../images/bird2.gif", "attr1":"Adult Male", "name":"Amazon Parrot", "descn":"Great companion for 75 years", "checked":false, "inStock":true, "quantity":1, "listPrice":193.50, "totalPrice":193.50, "buyerName":"j2ee" } ], "subTotal":193.50 } } ``` ------- ### 6.结算并返回被选中的商品 **Request** - Method: **POST** - URL: **/cart/myCart/checkAll** - Parameters: ``` { } ``` **Response** - fail ``` { "status": 10, "msg": "请先登录！" } ``` ``` { "status": 1, "msg": "购物车中没有商品被选中!" } ``` - success ``` { "status":0, "data":[ { "itemId":"EST-18", "productId":"AV-CB-01", "image":"../../images/bird2.gif", "attr1":"Adult Male", "name":"Amazon Parrot", "descn":"Great companion for 75 years", "checked":true, "inStock":true, "quantity":1, "listPrice":193.50, "totalPrice":193.50, "buyerName":"j2ee" } ] } ------ ### 7.改变购物车商品的checked状态 **Request** - Method: **POST** - URL: **/cart/myCart/changeChecked** - Parameters: ``` { itemId, checked } ``` **Response** - fail ``` { "status": 10, "msg": "请先登录！" } ``` - success ``` { "status": 0, "data": { "itemList": [ { "itemId": "EST-12", "productId": "RP-SN-01", "image": "../../images/lizard1.gif", "attr1": "Rattleless", "name": "Rattlesnake", "descn": "Doubles as a watch dog", "checked": true, "inStock": true, "quantity": 2, "listPrice": 18.5, "totalPrice": 37, "buyerName": "j2ee" } ], "subTotal": 37 } } ## Order ### 1.生成订单，清空购物车 **Request** - Method: **POST** - URL: **/order/orders/newOrder** - Parameters: ``` { expiryDate: "2022-05-01", billToFirstName: "张", creditCard: "123456", billToLastName: "三", billAddress1: "CS", billAddress2: "CSU", billCity: "CS", billState: "HN", billZip: "123456", billCountry: "CN", cardType: "Visa", shippingAddressRequired: false, //以下参数是可选的，当shippingAddressRequired为true时需要传递 shipToFirstName: "张" shipToLastName: "三" shipAddress1: "xxx" shipAddress2: "xxx" shipCity: "xxx" shipState: "xxx" shipZip: "xxx" shipCountry: "xxx" } ``` **Response** - fail ``` { "status": 10, "msg": "请先登录！" } ``` - success ``` { "status": 0, "data": { "orderId": 1002, "username": "aaa", "orderDate": "2022-04-09T06:33:50.877+00:00", "shipAddress1": "CS", "shipAddress2": "CSU", "shipCity": "CS", "shipState": "HN", "shipZip": "123456", "shipCountry": "CN", "billAddress1": "CS", "billAddress2": "CSU", "billCity": "CS", "billState": "HN", "billZip": "123456", "billCountry": "CN", "courier": "UPS", "totalPrice": 105.50, "billToFirstName": "张", "billToLastName": "三", "shipToFirstName": "张", "shipToLastName": "三", "creditCard": "123456", "expiryDate": "2022-05-01", "cardType": "Visa", "locale": "CSU", "status": "待发货", "timestamp": "2022-04-09T06:33:50.877+00:00" } } ``` ------- ### 2.获取已登录账号的订单 **Request** - Method: **GET** - URL: **/order/orders** - Parameters: ``` ``` **Response** - fail ``` { "status": 10, "msg": "请先登录！" } { "status": 1, "msg": "订单为空！" } ``` - success ``` { "status": 0, "data": [ { "orderId": 1001, "username": "aaa", "orderDate": "2022-04-09T06:03:53.000+00:00", "shipAddress1": "CS", "shipAddress2": "CSU", "shipCity": "CS", "shipState": "HN", "shipZip": "123456", "shipCountry": "CN", "billAddress1": "CS", "billAddress2": "CSU", "billCity": "CS", "billState": "HN", "billZip": "123456", "billCountry": "CN", "courier": "UPS", "totalPrice": 82.00, "billToFirstName": "张", "billToLastName": "三", "shipToFirstName": "张", "shipToLastName": "三", "creditCard": "123456", "expiryDate": "2022-05-01", "cardType": "Visa", "locale": "CSU", "status": "待发货", "timestamp": "2022-04-09T06:03:53.000+00:00" }, { "orderId": 1002, "username": "aaa", "orderDate": "2022-04-09T06:33:51.000+00:00", "shipAddress1": "CS", "shipAddress2": "CSU", "shipCity": "CS", "shipState": "HN", "shipZip": "123456", "shipCountry": "CN", "billAddress1": "CS", "billAddress2": "CSU", "billCity": "CS", "billState": "HN", "billZip": "123456", "billCountry": "CN", "courier": "UPS", "totalPrice": 105.50, "billToFirstName": "张", "billToLastName": "三", "shipToFirstName": "张", "shipToLastName": "三", "creditCard": "123456", "expiryDate": "2022-05-01", "cardType": "Visa", "locale": "CSU", "status": "待发货", "timestamp": "2022-04-09T06:33:51.000+00:00" } ] } ``` ------- ### 3.根据订单号获取订单 **Request** - Method: **GET** - URL: **/order/orders/{orderId}** - Parameters: ``` ``` **Response** - fail ``` { "status": 10, "msg": "请先登录！" } { "status": 1, "msg": "您查询的订单不存在！" } ``` - success ``` { "status": 0, "data": { "orderId": 1002, "username": "aaa", "orderDate": "2022-04-09T06:33:51.000+00:00", "shipAddress1": "CS", "shipAddress2": "CSU", "shipCity": "CS", "shipState": "HN", "shipZip": "123456", "shipCountry": "CN", "billAddress1": "CS", "billAddress2": "CSU", "billCity": "CS", "billState": "HN", "billZip": "123456", "billCountry": "CN", "courier": "UPS", "totalPrice": 105.50, "billToFirstName": "张", "billToLastName": "三", "shipToFirstName": "张", "shipToLastName": "三", "creditCard": "123456", "expiryDate": "2022-05-01", "cardType": "Visa", "locale": "CSU", "status": "待发货", "timestamp": "2022-04-09T06:33:51.000+00:00" } } ``` ------- ### 4.根据订单号获取该订单购买的商品 **Request** - Method: **GET** - URL: **/order/orders/{orderId}/items** - Parameters: ``` ``` **Response** - fail ``` { "status": 10, "msg": "请先登录！" } { "status": 1, "msg": "您查询的订单不存在！" } ``` - success ``` { "status": 0, "data": [ { "orderId": 1005, "lineNumber": 1007, "itemId": "EST-14", "quantity": 2, "listPrice": 58.50, "descn": "Great for reducing mouse populations", "totalPrice": 117.00 }, { "orderId": 1005, "lineNumber": 1008, "itemId": "EST-15", "quantity": 2, "listPrice": 23.50, "descn": "Great for reducing mouse populations", "totalPrice": 47.00 } ] } ``` ------- ### 5.火区OrderVO的List **Request** - Method: **GET** - URL: **/order/orders/{orderId}/items** - Parameters: ``` ``` **Response** - fail ``` { "status": 10, "msg": "请先登录！" } ``` - success ``` { "status":0, "data":[{ "order":{ "orderId":1002, "username":"j2ee", "orderDate":"2022-04-18T14:23:05.000+00:00", "shipAddress1":"901 San Antonio Road", "shipAddress2":"MS UCUP02-206", "shipCity":"Palo Alto", "shipState":"CA", "shipZip":"94303", "shipCountry":"USA", "billAddress1":"901 San Antonio Road", "billAddress2":"MS UCUP02-206", "billCity":"Palo Alto", "billState":"CA", "billZip":"94303", "billCountry":"USA", "courier":"UPS", "totalPrice":34.00, "billToFirstName":"j2ee", "billToLastName":"XYX", "shipToFirstName":"j2ee", "shipToLastName":"XYX", "creditCard":"", "expiryDate":"", "cardType":"Visa", "locale":"CSU", "status":"待发货", "timestamp":"2022-04-18T14:23:05.000+00:00" }, "firstLineItem":{ "orderId":1002, "lineNumber":1002, "itemId":"EST-19", "quantity":1, "listPrice":15.50, "descn":"Great stress reliever", "totalPrice":15.50, "image":"../../images/bird1.gif", "attr1":"Adult Male", "name":"Finch" }, "lineItemList":[], "len":1 ]} } ``` ------- ### 6.支付 **Request** - Method: **POST** - URL: **/pay** - Parameters: ``` { totalPrice: 205.50, orderId: 1234, billToFirstName: "张", billAddress1: "CSU" } ``` **Response** - fail ``` ``` - success ``` ``` -------