客户表做增删改查后端API接口文档.md

实现对客户表做增删改查后端API接口文档

1.1. API V1 接口说明

• 接口基准地址：http://127.0.0.1:8888/api/customer
• 服务端已开启 CORS 跨域支持
• 数据返回格式统一使用 JSON

1.1.1. 支持的请求方法

• GET（SELECT）：从服务器取出资源（一项或多项）。

• POST（CREATE）：在服务器新建一个资源。

• PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。

• DELETE（DELETE）：从服务器删除资源。

  1.1.2. 通用返回状态说明

  状态码	含义	说明
  200	OK	请求成功
  400	FAILURE	请求失败

1.2. 客户管理

1.2.1. 客户列表

• 请求路径：selectall

• 请求方法：GET

• 响应数据说明

  • id：客户ID（Integer）
  • username：用户名（String）
  • jobs：工作（String）
  • phone：电话（String）

• 响应数据

[
    {
        "id": 1,
        "username": "Timber",
        "jobs": "架构师",
        "phone": "18888888888"
    },
    {
        "id": 2,
        "username": "MinatoAqua",
        "jobs": "VTuber",
        "phone": "14454454455"
    },
    {
        "id": 3,
        "username": "Mea",
        "jobs": "VTuber",
        "phone": "16666666666"
    },
    {
        "id": 4,
        "username": "嘉然今天吃什么",
        "jobs": "VUP",
        "phone": "15555555555"
    },
    {
        "id": 5,
        "username": "安德森少校",
        "jobs": "铁驭（Pilot）",
        "phone": "16666666666"
    }
]

1.2.2. 添加客户

• 请求路径：add
• 请求方法：POST
• 请求参数

参数名	参数说明	备注
username	客户名称	不能为空
jobs	客户工作	不能为空
phone	客户电话	不能为空

• 响应参数

参数名	参数说明	备注
200	添加成功
400	添加失败

• 响应数据

200

1.5.3. 根据 ID 查询客户

• 请求路径：info/:id
• 请求方法：GET
• 请求参数

参数名	参数说明	备注
:id	角色 ID	不能为空携带在url中

• 响应参数

参数名	参数说明	备注
id	客户 ID
username	客户名称
jobs	客户工作
phone	客户电话

• 响应数据

{
    "id": 2,
    "username": "MinatoAqua",
    "jobs": "VTuber",
    "phone": "14454454455"
}

1.5.4. 编辑提交客户

• 请求路径：update
• 请求方法：PUT
• 请求参数

参数名	参数说明	备注
id	客户 ID	不能为空
username	客户名称	不能为空
jobs	客户工作	不能为空
phone	客户电话	不能为空

• 响应数据

200 // 修改成功
400 // 修改失败

1.5.5. 删除客户

• 请求路径：delete
• 请求方法：DELETE
• 请求参数

参数名	参数说明	备注
:id	角色 ID	不能为空携带在url中

• 响应数据

200 // 删除成功
400 // 删除失败