产品需求文档

主题

9. 接口定义 ​

本版本为纯文档脚手架，无后端接口。以下为示例格式，供后续版本参考。

接口列表 ​

示例接口：获取版本列表 ​

URL： /api/versionsMethod： GET描述： 获取所有 PRD 版本列表

请求参数：

参数类型必填说明
statusstring否筛选状态：draft/review/confirmed/released
pageint否页码，默认 1
sizeint否每页条数，默认 20

响应数据：

json
{
  "code": 0,
  "data": {
    "list": [
      {
        "version": "v1.0.0",
        "status": "released",
        "date": "2025-05-09",
        "title": "MVP 版本",
        "description": "产品最小可用版本"
      }
    ],
    "total": 1,
    "page": 1,
    "size": 20
  },
  "message": "success"
}

示例接口：获取版本详情 ​

URL： /api/versions/:versionMethod： GET描述： 获取指定版本的完整 PRD 内容

路径参数：

参数类型必填说明
versionstring是版本号，如 v1.0.0

响应数据：

json
{
  "code": 0,
  "data": {
    "version": "v1.0.0",
    "status": "released",
    "sections": [
      {
        "type": "background",
        "title": "项目背景",
        "content": "..."
      }
    ]
  },
  "message": "success"
}

示例接口：创建新版本 ​

URL： /api/versionsMethod： POST描述： 创建新版本的 PRD

请求体：

json
{
  "version": "v1.1.0",
  "iteration_goal": "新增用户反馈功能",
  "author": "产品经理"
}

响应数据：

json
{
  "code": 0,
  "data": {
    "version": "v1.1.0",
    "status": "draft",
    "created_at": "2025-05-10T10:00:00Z"
  },
  "message": "success"
}

错误码 ​

错误码说明
0成功
400请求参数错误
404版本不存在
409版本已存在
500服务器内部错误