Requirement Example

Java 后端需求示例

把后端接口需求拆成数据模型、接口范围、权限、异常、联调、部署和交接资料。

示例场景

客户已有前端原型,需要 Spring Boot 后端提供用户、订单、文件和审核接口,并部署到自有服务器。

真实需求不必和这个场景完全一样,但应该达到同样的颗粒度:目标、角色、首版范围、暂不做范围、验收和部署都要能落到具体描述。

好需求写法

下面这些内容可以直接作为任务包草稿,再根据真实项目替换细节。

调用端

调用端

接口给网页管理端和微信小程序同时使用,管理端负责审核和导出,小程序负责用户提交和查询。

核心数据对象

核心数据对象

用户、订单、订单明细、附件、审核记录、系统配置、管理员、角色和操作日志。

接口范围

接口范围

登录、用户信息、订单列表、订单详情、新增订单、上传附件、审核通过/驳回、配置查询和后台导出。

权限边界

权限边界

普通用户只能看自己的数据;管理员按角色看到不同菜单;审核接口只允许审核角色调用。

异常规则

异常规则

重复提交、附件超限、未登录、无权限、订单状态不允许修改和导出超时都要返回清晰错误码。

部署环境

部署环境

JDK、MySQL、Redis、Nginx、日志路径、备份策略、环境变量名和健康检查地址需要记录。

验收标准

验收标准

Postman 或 Swagger 能跑通核心接口;数据库脚本可初始化;测试账号能覆盖普通用户、审核员和管理员。

验收重点

接口要测正常请求、缺字段、无权限、状态不允许、文件超限和导出边界。
数据库索引、唯一约束、逻辑删除、创建/更新时间和操作日志要能解释清楚。
部署后必须验证健康检查、日志输出、重启方式、数据库连接和反向代理。
接口文档、测试账号、数据库脚本和环境变量清单必须能交给下一位 AI 复现。

不要这样做

不要没有数据模型就直接写 Controller。
不要把数据库、Redis、后台管理端口直接暴露公网。
不要把 JWT 密钥、数据库密码、对象存储密钥写进代码或聊天记录。
Contact

把示例改成你的真实需求

如果信息还不完整,就先保留“待补”,但不要省略首版范围、验收标准、部署环境和交接备注。

刘鸡血 微信二维码微信扫码添加