{
  "module": "职员管理",
  "moduleKey": "staff",
  "apiCount": 5,
  "apis": [
    {
      "title": "获取职员列表",
      "method": "GET",
      "path": "/api/staff",
      "description": "获取职员列表，支持按部门筛选",
      "requestParams": {
        "query": [
          {
            "name": "pageNum",
            "type": "number",
            "required": false,
            "description": "页码，默认1"
          },
          {
            "name": "pageSize",
            "type": "number",
            "required": false,
            "description": "每页数量，默认10"
          },
          {
            "name": "organizationId",
            "type": "string",
            "required": false,
            "description": "所属组织筛选"
          },
          {
            "name": "name",
            "type": "string",
            "required": false,
            "description": "姓名关键词"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "获取成功",
          "data": {
            "list": [
              {
                "id": 1,
                "code": "STA0001",
                "name": "张三",
                "phone": "13800000001",
                "organizationId": "ORG0001",
                "status": 1,
                "createTime": "2025-01-01T10:00:00.000Z"
              }
            ],
            "total": 100,
            "pageNum": 1,
            "pageSize": 10
          }
        }
      }
    },
    {
      "title": "获取职员详情",
      "method": "GET",
      "path": "/api/staff/{id}",
      "description": "根据职员ID获取职员详细信息",
      "requestParams": {
        "path": [
          {
            "name": "id",
            "type": "string",
            "required": true,
            "description": "职员ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "获取成功",
          "data": {
            "id": 1,
            "code": "STA0001",
            "name": "张三",
            "phone": "13800000001",
            "organizationId": "ORG0001",
            "status": 1,
            "createTime": "2025-01-01T10:00:00.000Z"
          }
        },
        "failure": {
          "code": "4040",
          "message": "职员不存在",
          "data": null
        }
      }
    },
    {
      "title": "创建职员",
      "method": "POST",
      "path": "/api/staff",
      "description": "创建新的职员",
      "requestParams": {
        "body": {
          "name": "string｜必填，职员姓名",
          "phone": "string｜必填，手机号",
          "organizationId": "string｜必填，所属组织ID",
          "status": "number｜可选，状态：1-在职，0-离职"
        }
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "创建职员成功",
          "data": {
            "id": 1,
            "code": "STA0001",
            "name": "张三",
            "phone": "13800000001",
            "organizationId": "ORG0001",
            "status": 1,
            "createTime": "2025-01-01T10:00:00.000Z"
          }
        },
        "failure": {
          "code": "4000",
          "message": "创建职员失败",
          "data": null
        }
      }
    },
    {
      "title": "更新职员",
      "method": "PUT",
      "path": "/api/staff/{id}",
      "description": "更新指定职员的信息",
      "requestParams": {
        "body": {
          "name": "string｜必填，职员姓名",
          "phone": "string｜必填，手机号",
          "organizationId": "string｜必填，所属组织ID",
          "status": "number｜可选，状态：1-在职，0-离职"
        },
        "path": [
          {
            "name": "id",
            "type": "string",
            "required": true,
            "description": "职员ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "更新职员成功",
          "data": {
            "id": 1,
            "code": "STA0001",
            "name": "张三",
            "phone": "13800000001",
            "organizationId": "ORG0001",
            "status": 1,
            "createTime": "2025-01-01T10:00:00.000Z"
          }
        },
        "failure": {
          "code": "4000",
          "message": "更新职员失败",
          "data": null
        }
      }
    },
    {
      "title": "删除职员",
      "method": "DELETE",
      "path": "/api/staff/{id}",
      "description": "删除指定的职员",
      "requestParams": {
        "path": [
          {
            "name": "id",
            "type": "string",
            "required": true,
            "description": "职员ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "删除职员成功",
          "data": {
            "result": true
          }
        },
        "failure": {
          "code": "4000",
          "message": "删除职员失败",
          "data": null
        }
      }
    }
  ]
}