← 返回首页

API模块详情

当前查看模块：member

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

参数名 必填 类型 示例 说明
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）。当系统不支持时将返回“登录用户不支持当前系统，可联系管理员处理”。

会员管理

模块标识: member | 接口数量: 7

GET 获取有效会员列表 /api/members/valid-list

查看详情
获取所有状态为有效（status=1）的会员套餐列表，用于下拉选择。无需分页，返回简化的字段信息。
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数

暂无请求参数定义

响应示例
{
  "success": {
    "code": "0000",
    "message": "操作成功",
    "data": [
      {
        "id": "xxx",
        "_id": "xxx",
        "code": "MEM0001",
        "name": "会员套餐1",
        "description": "套餐描述"
      },
      {
        "id": "yyy",
        "_id": "yyy",
        "code": "MEM0002",
        "name": "会员套餐2",
        "description": "套餐描述"
      }
    ],
    "timestamp": "2025-01-21T10:00:00.000Z"
  },
  "failure": {
    "code": "4000",
    "message": "获取失败",
    "data": null
  }
}
注意事项
  • 该接口仅返回状态为有效（status=1）的会员套餐
  • 返回结果按创建时间升序排序
  • 需要 members 的 read 权限
  • 适用于下拉选择等场景，无需分页

GET 获取会员列表 /api/members

查看详情
分页获取会员套餐列表
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数
参数名 必填 类型 示例 说明
pageNum 否 number - 页码，默认1
pageSize 否 number - 每页数量，默认10
name 否 string - 套餐名称关键词
memberTypeId 否 string - 会员类型ID（会员类型管理记录的_id）
响应示例
{
  "success": {
    "code": "0000",
    "message": "获取成功",
    "data": {
      "list": [
        {
          "id": 1,
          "code": "MEM0001",
          "name": "会员套餐名称",
          "memberTypeId": "xxx",
          "price": "99.99",
          "validityDays": 30,
          "description": "套餐描述",
          "status": 1
        }
      ],
      "total": 100,
      "pageNum": 1,
      "pageSize": 10
    }
  }
}

GET 获取会员详情 /api/members/{id}

查看详情
根据会员套餐ID获取会员套餐详细信息
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数
参数名 必填 类型 示例 说明
id 是 string - 会员套餐ID
响应示例
{
  "success": {
    "code": "0000",
    "message": "获取成功",
    "data": {
      "id": 1,
      "code": "MEM0001",
      "name": "会员套餐名称",
      "memberTypeId": "xxx",
      "price": "99.99",
      "validityDays": 30,
      "description": "套餐描述",
      "status": 1
    }
  },
  "failure": {
    "code": "4040",
    "message": "会员套餐不存在",
    "data": null
  }
}

POST 创建会员 /api/members

查看详情
创建新的会员套餐
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数

请求体

{
  "name": "string｜必填，套餐名称",
  "memberTypeId": "string｜可选，会员类型ID（会员类型管理记录的_id），如果提供会校验会员类型是否存在",
  "price": "string｜可选，价格（两位小数，如：99.99）",
  "validityDays": "number｜可选，有效期天数（最小值为1）",
  "description": "string｜可选，套餐描述",
  "status": "number｜可选，状态：1-有效，0-无效，默认0"
}

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

响应示例
{
  "success": {
    "code": "0000",
    "message": "创建会员成功",
    "data": {
      "id": 1,
      "code": "MEM0001",
      "name": "会员套餐名称",
      "memberTypeId": "xxx",
      "price": "99.99",
      "validityDays": 30,
      "description": "套餐描述",
      "status": 0
    }
  },
  "failure": {
    "code": "4000",
    "message": "关联的会员类型不存在",
    "data": null
  }
}
注意事项
  • 如果提供了memberTypeId，会校验会员类型是否存在，不存在返回错误：关联的会员类型不存在

PUT 更新会员 /api/members/{id}

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

请求体

{
  "name": "string｜必填，套餐名称",
  "memberTypeId": "string｜可选，会员类型ID（会员类型管理记录的_id），如果提供会校验会员类型是否存在",
  "price": "string｜可选，价格（两位小数，如：99.99）",
  "validityDays": "number｜可选，有效期天数（最小值为1）",
  "description": "string｜可选，套餐描述",
  "status": "number｜可选，状态：1-有效，0-无效，默认0"
}

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

响应示例
{
  "success": {
    "code": "0000",
    "message": "更新会员成功",
    "data": {
      "id": 1,
      "code": "MEM0001",
      "name": "会员套餐名称",
      "memberTypeId": "xxx",
      "price": "99.99",
      "validityDays": 30,
      "description": "套餐描述",
      "status": 1
    }
  },
  "failure": {
    "code": "4000",
    "message": "关联的会员类型不存在",
    "data": null
  }
}
注意事项
  • 如果提供了memberTypeId，会校验会员类型是否存在，不存在返回错误：关联的会员类型不存在
  • 有效状态（status=1）的会员套餐不允许修改，会返回错误：有效状态的会员套餐不允许修改

DELETE 删除会员 /api/members/{id}

查看详情
删除指定的会员套餐
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数
参数名 必填 类型 示例 说明
id 是 string - 会员套餐ID
响应示例
{
  "success": {
    "code": "0000",
    "message": "删除会员成功",
    "data": {
      "result": true
    }
  },
  "failure": {
    "code": "4000",
    "message": "删除会员失败",
    "data": null
  }
}
注意事项
  • 有效状态（status=1）的会员套餐不允许删除，会返回错误：有效状态的会员套餐不允许删除

PUT 切换会员套餐状态 /api/members/{id}/status

查看详情
切换会员套餐的启用/禁用状态
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数
参数名 必填 类型 示例 说明
id 是 string - 会员套餐ID

请求体

{
  "status": "number｜必填，状态：1-有效，0-无效"
}

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

响应示例
{
  "success": {
    "code": "0000",
    "message": "状态更新成功",
    "data": {
      "id": 1,
      "code": "MEM0001",
      "name": "会员套餐名称",
      "memberTypeId": "xxx",
      "price": "99.99",
      "validityDays": 30,
      "description": "套餐描述",
      "status": 1,
      "updateTime": "2025-01-01T10:00:00.000Z"
    }
  },
  "failure": {
    "code": "4040",
    "message": "会员套餐不存在",
    "data": null
  }
}
注意事项
  • 该接口用于切换会员套餐的启用/禁用状态
  • 只有通过状态切换接口才能修改有效状态的会员套餐