接口文档 - 需求管理系统

基本信息

Base URL:

认证: 无需认证，公开访问

CORS: 全开放（Access-Control-Allow-Origin: *）

Content-Type: application/json

接口列表

GET/api/requirements查询需求列表

查询参数

参数	类型	必填	说明
requirement_name	string	否	按需求名称模糊搜索
module	string	否	按所属模块模糊搜索
status	string	否	按需求状态模糊搜索
priority	string	否	按优先级模糊搜索
limit	number	否	每页条数，默认50，最大500
offset	number	否	偏移量，默认0

请求示例

# 查询全部
curl /api/requirements

# 按模块+状态筛选
curl "/api/requirements?module=库存&status=8.已上线&limit=10"

响应示例

{
  "data": [{"id":1,"requirement_name":"...","module":"库存",...}],
  "total": 1,
  "limit": 50,
  "offset": 0
}

GET/api/requirements/:id查询单条需求

请求示例

curl /api/requirements/1

成功响应

{ "data": { "id": 1, "requirement_name": "...", ... } }

错误响应 (404)

{ "error": "未找到该需求" }

POST/api/requirements新增需求

请求体

字段	类型	必填	说明
requirement_name	string	是	需求名称
created_date	string	是	需求创建日期
module	string	否	所属模块
priority	string	否	优先级
status	string	否	需求状态
...其他字段	string	否	见字段对照表

请求示例

curl -X POST /api/requirements \
  -H "Content-Type: application/json" \
  -d '{"requirement_name":"测试需求","created_date":"2025/07/14","module":"库存"}'

成功响应 (201)

{ "message": "创建成功", "id": 1 }

错误响应 (400)

{ "error": "requirement_name（需求名称）为必填字段" }

PUT/api/requirements/:id更新需求

只需传入要更新的字段，未传的字段保持不变。

请求示例

curl -X PUT /api/requirements/1 \
  -H "Content-Type: application/json" \
  -d '{"status": "7.已关闭", "dev_test_progress": "100%"}'

成功响应

{ "message": "更新成功", "data": { "id": 1, ... } }

错误响应 (404)

{ "error": "未找到该需求" }

DELETE/api/requirements/:id删除需求

请求示例

curl -X DELETE /api/requirements/1

成功响应

{ "message": "删除成功", "id": 1 }

POST/api/requirements/batch-delete批量删除需求

请求体

字段	类型	必填	说明
ids	number[]	是	要删除的需求ID数组

请求示例

curl -X POST /api/requirements/batch-delete \
  -H "Content-Type: application/json" \
  -d '{"ids": [1, 2, 3]}'

成功响应

{ "message": "批量删除成功", "deleted": 3 }

GET/health健康检查

{ "status": "ok", "service": "需求管理 API" }

状态码说明

状态码	说明
200	请求成功
201	创建成功
400	请求参数错误
404	资源不存在

字段中英文对照表

字段名	中文名
requirement_name	需求名称
requirement_description	需求描述
module	所属模块
requirement_type	需求类型
requirement_category	需求分类
expected_launch_date	期望上线时间
priority	优先级
status	需求状态
business_unit	业务提出方
proposed_by	需求提出人
product_owner	产品负责人
dev_test_owner	开发/测试负责人
requirement_number	需求编号
created_date	需求创建日期
actual_launch_date	实际上线日期
iteration	迭代
dev_test_progress_old	开发测试进度-旧
dev_test_progress	开发测试进度
total_dev_tasks	开发任务总数
completed_tasks	已完成任务数
cancelled_tasks	已取消任务数
in_progress_tasks	进行中任务数
remarks	备注
attachment_1 ~ attachment_4	附件_1 ~ 附件_4
business_requirement	业务需求
linked_business_requirement	关联：业务需求
page_adjusted	页面是否调整
single_option	单选项
created_at	记录创建时间（自动）
updated_at	记录更新时间（自动）

📖 接口文档

基本信息

接口列表

查询参数

请求示例

响应示例

请求示例

成功响应

错误响应 (404)

请求体

请求示例

成功响应 (201)

错误响应 (400)

请求示例

成功响应

错误响应 (404)

请求示例

成功响应

请求体

请求示例

成功响应

状态码说明

字段中英文对照表