← 返回首页

API模块详情

当前查看模块：customer

公共请求头（所有接口适用）

参数名 必填 类型 示例 说明
Authorization 否 string Bearer <JWT token> 用户登录后的 JWT 令牌。若已登录可直接使用，无需传 X-Client。。认证 Token，请在请求头中携带，推荐格式：Bearer {token}
X-Client 否 string <client key token> 客户端密钥。当未携带或无法使用 Authorization 时必填，用于密钥认证。线上文档： http://localhost:5601/docs
X-Site 是 string <site key> 站点标识（必填）。用于切换站点和对应的数据库上下文。所有 OpenAPI 接口必须提供有效的 X-Site header。
X-System-Code 是 string AUTH_MANAGEMENT 系统编码（必填）。用于指定当前访问的业务系统（例如 AUTH_MANAGEMENT、CONTENT_MANAGEMENT）。当系统不支持时将返回“登录用户不支持当前系统，可联系管理员处理”。

客户管理

模块标识: customer | 接口数量: 5

GET 获取客户列表 /api/customers

查看详情
分页获取客户列表
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数
参数名 必填 类型 示例 说明
pageNum 否 number - 页码，默认1
pageSize 否 number - 每页数量，默认10
name 否 string - 客户名称关键词
status 否 number - 状态过滤
响应示例
{
  "success": {
    "code": "0000",
    "message": "获取成功",
    "data": {
      "list": [
        {
          "id": 1,
          "code": "CUS0001",
          "name": "示例客户",
          "contactName": "李四",
          "contactPhone": "021-88888888",
          "status": 1
        }
      ],
      "total": 100,
      "pageNum": 1,
      "pageSize": 10
    }
  }
}

GET 获取客户详情 /api/customers/{id}

查看详情
根据客户ID获取客户详细信息
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数
参数名 必填 类型 示例 说明
id 是 string - 客户ID
响应示例
{
  "success": {
    "code": "0000",
    "message": "获取成功",
    "data": {
      "id": 1,
      "code": "CUS0001",
      "name": "示例客户",
      "contactName": "李四",
      "contactPhone": "021-88888888",
      "status": 1
    }
  },
  "failure": {
    "code": "4040",
    "message": "客户不存在",
    "data": null
  }
}

POST 创建客户 /api/customers

查看详情
创建新的客户
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数

请求体

{
  "name": "string｜必填，客户名称",
  "contactName": "string｜可选，联系人姓名",
  "contactPhone": "string｜可选，联系人电话",
  "status": "number｜可选，状态：1-合作中，0-已终止"
}

请按照示例结构封装请求体字段，并确保必填字段完整。

响应示例
{
  "success": {
    "code": "0000",
    "message": "创建客户成功",
    "data": {
      "id": 1,
      "code": "CUS0001",
      "name": "示例客户",
      "contactName": "李四",
      "contactPhone": "021-88888888",
      "status": 1
    }
  },
  "failure": {
    "code": "4000",
    "message": "创建客户失败",
    "data": null
  }
}

PUT 更新客户 /api/customers/{id}

查看详情
更新指定客户的信息
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数
参数名 必填 类型 示例 说明
id 是 string - 客户ID

请求体

{
  "name": "string｜必填，客户名称",
  "contactName": "string｜可选，联系人姓名",
  "contactPhone": "string｜可选，联系人电话",
  "status": "number｜可选，状态：1-合作中，0-已终止"
}

请按照示例结构封装请求体字段，并确保必填字段完整。

响应示例
{
  "success": {
    "code": "0000",
    "message": "更新客户成功",
    "data": {
      "id": 1,
      "code": "CUS0001",
      "name": "示例客户",
      "contactName": "李四",
      "contactPhone": "021-88888888",
      "status": 1
    }
  },
  "failure": {
    "code": "4000",
    "message": "更新客户失败",
    "data": null
  }
}

DELETE 删除客户 /api/customers/{id}

查看详情
删除指定的客户
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数
参数名 必填 类型 示例 说明
id 是 string - 客户ID
响应示例
{
  "success": {
    "code": "0000",
    "message": "删除客户成功",
    "data": {
      "result": true
    }
  },
  "failure": {
    "code": "4000",
    "message": "删除客户失败",
    "data": null
  }
}