上一篇
服务器接口文档中哪些关键细节需要特别注意以避免错误使用?
- 云服务器
- 2025-12-08
- 7
服务器接口文档
本接口文档旨在为开发者提供关于服务器接口的详细说明,包括接口的基本信息、请求参数、返回结果等,通过阅读本文档,开发者可以快速了解和使用我们的服务器接口。
接口列表
以下是我们提供的接口列表,每个接口都包含接口名称、接口描述、请求参数、返回结果等信息。
| 接口名称 | 接口描述 | 请求参数 | 返回结果 |
|---|---|---|---|
| 用户登录 | 用户登录接口 | username, password | token, userInfo |
| 用户注册 | 用户注册接口 | username, password, email | userInfo, token |
| 用户信息修改 | 用户信息修改接口 | token, userInfo | userInfo |
| 用户信息查询 | 用户信息查询接口 | token | userInfo |
| 商品列表查询 | 商品列表查询接口 | category, page, size | goodsList, totalCount |
| 商品详情查询 | 商品详情查询接口 | goodsId | goodsInfo |
| 购物车添加 | 购物车添加接口 | token, goodsId | result |
| 购物车删除 | 购物车删除接口 | token, goodsId | result |
| 购物车列表查询 | 购物车列表查询接口 | token | cartList |
| 订单创建 | 订单创建接口 | token, goodsId, quantity | orderId |
| 订单查询 | 订单查询接口 | orderId | orderInfo |
| 订单取消 | 订单取消接口 | orderId | result |
| 订单支付 | 订单支付接口 | orderId, payType | result |
请求参数说明
以下是对接口请求参数的详细说明:
用户登录接口
- username:用户名,必填
- password:密码,必填
用户注册接口
- username:用户名,必填
- password:密码,必填
- email:邮箱,必填
用户信息修改接口
- token:用户登录时返回的token,必填
- userInfo:用户信息,必填,格式为JSON字符串
用户信息查询接口
- token:用户登录时返回的token,必填
商品列表查询接口
- category:商品分类,可选
- page:当前页码,可选,默认为1
- size:每页显示数量,可选,默认为10
商品详情查询接口
- goodsId:商品ID,必填
购物车添加接口
- token:用户登录时返回的token,必填
- goodsId:商品ID,必填
购物车删除接口
- token:用户登录时返回的token,必填
- goodsId:商品ID,必填
购物车列表查询接口
- token:用户登录时返回的token,必填
订单创建接口
- token:用户登录时返回的token,必填
- goodsId:商品ID,必填
- quantity:购买数量,必填
订单查询接口
- orderId:订单ID,必填
订单取消接口
- orderId:订单ID,必填
订单支付接口

- orderId:订单ID,必填
- payType:支付类型,必填,alipay, wechatpay
返回结果说明
以下是对接口返回结果的详细说明:
用户登录接口
- token:用户登录时返回的token,用于后续接口调用
- userInfo:用户信息,包括用户名、邮箱等
用户注册接口
- userInfo:用户信息,包括用户名、邮箱等
- token:用户登录时返回的token
用户信息修改接口
- userInfo:修改后的用户信息
用户信息查询接口
- userInfo:用户信息
商品列表查询接口
- goodsList:商品列表
- totalCount:商品总数
商品详情查询接口
- goodsInfo:商品详细信息
购物车添加接口


- result:操作结果,成功或失败
购物车删除接口
- result:操作结果,成功或失败
购物车列表查询接口
- cartList:购物车列表
订单创建接口
- orderId:订单ID
订单查询接口
- orderInfo:订单详细信息
订单取消接口
- result:操作结果,成功或失败
订单支付接口
- result:操作结果,成功或失败
FAQs
问题:如何获取用户登录的token?
解答:用户登录成功后,接口会返回一个token,该token用于后续接口调用,请妥善保管该token,避免泄露。
问题:如何修改用户信息?
解答:需要调用用户信息查询接口获取用户信息,调用用户信息修改接口,传入token和修改后的用户信息即可。