宠物商城系统接口文档（用户 / 宠物 / 订单）

基于RESTful 规范设计包含用户模块、宠物模块、订单模块核心接口支持前后端直接对接接口清晰、可直接用于开发。通用规范请求方式GET (查询)、POST (新增)、PUT (修改)、DELETE (删除)数据格式请求 / 响应均使用JSON基础路径/api/v1统一响应格式json{ code: 200, // 状态码200成功400参数错误401未授权500服务器异常 msg: 操作成功, // 提示信息 data: {} // 业务数据 }一、用户模块接口负责用户注册、登录、信息管理核心身份接口1. 用户注册接口地址POST /api/v1/user/register请求参数json{ username: zhangsan, // 用户名必填 password: 123456, // 密码必填 phone: [phone], // 手机号必填 nickname: 张三 // 昵称可选 }响应示例json{ code: 200, msg: 注册成功, data: { userId: 1001 } }2. 用户登录接口地址POST /api/v1/user/login请求参数json{ username: zhangsan, password: 123456 }响应示例json{ code: 200, msg: 登录成功, data: { userId: 1001, token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..., // 身份凭证 nickname: 张三 } }3. 获取用户信息接口地址GET /api/v1/user/info请求头Authorization: Bearer {token}响应示例json{ code: 200, msg: success, data: { userId: 1001, username: zhangsan, nickname: 张三, phone: [phone], createTime: 2025-05-20 10:00:00 } }4. 修改用户信息接口地址PUT /api/v1/user/update请求头Authorization: Bearer {token}请求参数json{ nickname: 张三_new, phone: [phone] }二、宠物模块接口负责宠物信息查询、上架、修改商品核心接口1. 查询宠物列表分页接口地址GET /api/v1/pet/list请求参数Querypage页码默认 1size每页条数默认 10category宠物分类可选如猫 / 狗 / 仓鼠status状态0 下架 1 上架响应示例json{ code: 200, msg: success, data: { total: 50, pages: 5, current: 1, records: [ { petId: 1, petName: 布偶猫, category: 猫, age: 6个月, price: 3999.00, stock: 10, petPic: https://xxx.com/cat.jpg, status: 1 } ] } }2. 查询宠物详情接口地址GET /api/v1/pet/detail/{petId}路径参数petId 宠物 ID响应示例json{ code: 200, msg: success, data: { petId: 1, petName: 布偶猫, category: 猫, age: 6个月, price: 3999.00, stock: 10, petPic: https://xxx.com/cat.jpg, detail: 温顺粘人疫苗齐全, createTime: 2025-05-18 14:30:00, status: 1 } }3. 新增宠物管理员接口地址POST /api/v1/pet/add请求参数json{ petName: 金毛犬, category: 狗, age: 1岁, price: 2599.00, stock: 8, petPic: https://xxx.com/dog.jpg, detail: 性格活泼适合家养 }4. 修改宠物信息接口地址PUT /api/v1/pet/update请求参数包含 petId5. 上下架宠物接口地址PUT /api/v1/pet/status请求参数json{ petId: 1, status: 0 // 0下架 1上架 }三、订单模块接口负责订单创建、查询、支付、取消交易核心接口1. 创建订单接口地址POST /api/v1/order/create请求头Authorization: Bearer {token}请求参数json{ petId: 1, // 宠物ID buyNum: 1, // 购买数量 receiver: 张三, // 收货人 phone: [phone], address: 北京市朝阳区XX小区 }响应返回订单 ID、订单金额2. 查询我的订单列表接口地址GET /api/v1/order/myList请求头Authorization: Bearer {token}请求参数page、size、orderStatus (可选)订单状态0 待支付 1 已支付 2 已发货 3 已完成 4 已取消响应示例json{ code: 200, msg: success, data: { total: 5, records: [ { orderId: ORDER20250520001, petName: 布偶猫, petPic: https://xxx.com/cat.jpg, totalPrice: 3999.00, orderStatus: 0, createTime: 2025-05-20 11:20:00 } ] } }3. 查询订单详情接口地址GET /api/v1/order/detail/{orderId}4. 取消订单接口地址PUT /api/v1/order/cancel/{orderId}请求头Authorization: Bearer {token}5. 订单支付接口地址PUT /api/v1/order/pay/{orderId}请求头Authorization: Bearer {token}总结这套接口覆盖用户、宠物、订单三大核心业务满足宠物商城基础功能统一响应格式、权限校验前后端可直接对接开发可直接用于毕业设计、课程设计、小型商城项目开发支持快速扩展支付、评价、购物车等接口