后端团队

与后端团队的约定，包括接口定义、接口文档等。这些约定可以帮助团队更好地协作，提高开发效率。

TIP

• 必要：要求严格实现。
• 应该：大部分情况应该实现，可以根据实际情况而定。
• 推荐：推荐的一些做法，能保持项目的整体统一性，提升用户体验。
• 避免：项目中应该避免出现该类问题。

基础

描述	级别
统一使用Apifox (opens new window)协同开发	应该
包含mock测试数据（至少包含一个code=200的测试数据）	应该
相同类型接口，请求类型应该相同，比如列表如果是get类型，那就都是用get类型。 推荐使用简单的RESTful风格（但不推荐使用其嵌套结构）： GET：获取资源 POST：创建资源 PUT：更新资源（全量） PATCH：更新资源（部分） DELETE：删除资源	应该

RESTful风格示例：

HTTP 方法 URL 描述 GET /users 获取用户列表 GET /users/123 获取单个用户 POST /users 创建新用户 PUT /users/123 全量更新用户信息 PATCH /users/123 部分更新用户信息 DELETE /users/123 删除用户

接口返回格式要统一(对象)：

{
  "code": 200,
  "message": "成功",
  "data": {}
}

接口返回格式要统一(列表)：

{
  "code": 200,
  "message": "成功",
  "data": {
    "list": [],
    "total": 0,
    "page": 1,
    "size": 10
  }
}