编写接口需求的上下游边界

分类:AI提示词 时间:2025-04-17 18:48 浏览:0
0

指令简介

接口文档只写请求参数还不够?这条指令帮你系统梳理一个模块的上下游接口交互,包括数据字段、调用频率、异常处理机制等,补齐技术视角下的细节盲区!

指令内容

请针对以下模块:【模块名称】,输出该模块的接口上下游交互边界信息,内容包含:
1、上游调用来源与触发条件(例如页面点击、定时任务)
2、下游调用对象与依赖系统
3、传输的数据字段(请求参数与返回字段)
4、调用频次与性能要求
5、异常处理机制(如失败重试、错误提示、日志记录)

指令示例

复制指令,把【】里面的信息更换成你的。
模块名称:用户注册接口模块


输出示例:
1、上游来源:前端注册页面点击“注册”按钮
2、下游依赖:短信验证码服务、用户数据库写入逻辑
3、数据字段:
(1)请求参数:手机号、验证码、密码
(2)返回字段:注册成功标志、用户ID、token
4、调用频次:每分钟不超过 100 次,超过限频提示
5、异常处理机制:
(1)验证码错误返回“验证码不正确”,不写数据库
(2)数据库写入失败记录日志并提示“注册失败,请稍后再试”


1. 本站所有资源来源于用户上传或网络,仅作为参考研究使用,如有侵权请邮件联系站长!
2. 本站积分货币获取途径以及用途的解读,想在本站混的好,请务必认真阅读!
3. 本站强烈打击盗版/破解等有损他人权益和违法作为,请各位会员支持正版!
4. AI提示词 > 编写接口需求的上下游边界

用户评论