{
  "module": "会员类型管理",
  "moduleKey": "memberType",
  "apiCount": 6,
  "apis": [
    {
      "title": "获取有效会员类型列表",
      "method": "GET",
      "path": "/api/members/types/valid-list",
      "description": "获取所有状态为有效（status=1）的会员类型列表，用于下拉选择。无需分页，返回简化的字段信息。",
      "requestParams": {},
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "操作成功",
          "data": [
            {
              "id": "xxx",
              "_id": "xxx",
              "code": "VIP",
              "name": "VIP会员",
              "description": "VIP会员类型"
            },
            {
              "id": "yyy",
              "_id": "yyy",
              "code": "GOLD",
              "name": "黄金会员",
              "description": "黄金会员类型"
            }
          ],
          "timestamp": "2025-01-21T10:00:00.000Z"
        },
        "failure": {
          "code": "4000",
          "message": "获取失败",
          "data": null
        }
      },
      "notes": [
        "该接口仅返回状态为有效（status=1）的会员类型",
        "返回结果按创建时间升序排序",
        "需要 memberTypes 的 read 权限",
        "适用于下拉选择等场景，无需分页"
      ]
    },
    {
      "title": "获取会员类型列表",
      "method": "GET",
      "path": "/api/members/types",
      "description": "分页获取会员类型列表，支持按名称、编码、状态筛选",
      "requestParams": {
        "query": [
          {
            "name": "pageNum",
            "type": "number",
            "required": false,
            "description": "页码，默认1"
          },
          {
            "name": "pageSize",
            "type": "number",
            "required": false,
            "description": "每页数量，默认10"
          },
          {
            "name": "name",
            "type": "string",
            "required": false,
            "description": "会员类型名称关键词"
          },
          {
            "name": "code",
            "type": "string",
            "required": false,
            "description": "会员类型编码关键词"
          },
          {
            "name": "status",
            "type": "number",
            "required": false,
            "description": "状态过滤：1-有效，0-无效"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "获取成功",
          "data": {
            "list": [
              {
                "id": 1,
                "code": "VIP",
                "name": "VIP会员",
                "description": "VIP会员类型",
                "status": 1,
                "createTime": "2025-01-01T10:00:00.000Z",
                "updateTime": "2025-01-01T10:00:00.000Z"
              }
            ],
            "total": 100,
            "pageNum": 1,
            "pageSize": 10,
            "totalPages": 10
          }
        }
      }
    },
    {
      "title": "创建会员类型",
      "method": "POST",
      "path": "/api/members/types",
      "description": "创建新的会员类型",
      "requestParams": {
        "body": {
          "name": "string｜必填，会员类型名称",
          "code": "string｜必填，会员类型编码",
          "status": "number｜可选，状态：1-有效，0-无效，默认1",
          "description": "string｜可选，描述信息"
        }
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "创建成功",
          "data": {
            "id": 1,
            "code": "VIP",
            "name": "VIP会员",
            "description": "VIP会员类型",
            "status": 1,
            "createTime": "2025-01-01T10:00:00.000Z"
          }
        },
        "failure": {
          "code": "4000",
          "message": "会员类型编码已存在",
          "data": null
        }
      }
    },
    {
      "title": "更新会员类型",
      "method": "PUT",
      "path": "/api/members/types/{typeId}",
      "description": "更新指定会员类型的信息",
      "requestParams": {
        "body": {
          "name": "string｜可选，会员类型名称",
          "code": "string｜可选，会员类型编码",
          "status": "number｜可选，状态：1-有效，0-无效",
          "description": "string｜可选，描述信息"
        },
        "path": [
          {
            "name": "typeId",
            "type": "string",
            "required": true,
            "description": "会员类型ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "更新成功",
          "data": {
            "id": 1,
            "code": "VIP",
            "name": "VIP会员",
            "description": "VIP会员类型",
            "status": 1,
            "updateTime": "2025-01-01T10:00:00.000Z"
          }
        },
        "failure": {
          "code": "4000",
          "message": "会员类型编码已存在",
          "data": null
        }
      }
    },
    {
      "title": "删除会员类型",
      "method": "DELETE",
      "path": "/api/members/types/{typeId}",
      "description": "删除指定的会员类型",
      "requestParams": {
        "path": [
          {
            "name": "typeId",
            "type": "string",
            "required": true,
            "description": "会员类型ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "删除成功",
          "data": null
        },
        "failure": {
          "code": "4000",
          "message": "会员类型仍与会员功能关联，请先解除关联",
          "data": null
        }
      }
    },
    {
      "title": "切换会员类型状态",
      "method": "PUT",
      "path": "/api/members/types/{typeId}/status",
      "description": "切换会员类型的启用/禁用状态",
      "requestParams": {
        "body": {
          "status": "number｜必填，状态：1-有效，0-无效"
        },
        "path": [
          {
            "name": "typeId",
            "type": "string",
            "required": true,
            "description": "会员类型ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "状态更新成功",
          "data": {
            "id": 1,
            "code": "VIP",
            "name": "VIP会员",
            "status": 1,
            "updateTime": "2025-01-01T10:00:00.000Z"
          }
        },
        "failure": {
          "code": "4040",
          "message": "会员类型不存在",
          "data": null
        }
      }
    }
  ]
}