API 接口文档
为调用方开发者写清认证方式、通用约定、错误码和每个接口的参数与示例，让对方照着文档就能完成对接。
提示词
撰写一份会员积分系统开放接口的 API 文档。目的：让合作方开发者照着文档独立完成对接。要求：写清各环境地址、认证方式和通用约定（请求格式、分页、幂等、限流、时间格式），给出错误码表和接口总表，每个接口列出方法与路径、请求参数表、响应字段表和成功、失败示例，有回调的说明签名校验与重试策略，并附变更记录。类型与必填项写准确，密钥用占位符，表述简洁。
- 来源
- Ofox
如何使用
- 1
点击「做同款」
进入 Ofox Chat，这份文稿的结构已经替你准备好。未登录时先登录。
- 2
改成你想要的
提示词里高亮的部分可以直接改，换成你自己的内容。
- 3
发送并生成
发送后 Ofox Chat 写出完整文档，可以直接下载；不满意可以继续对话修改。
常见问题
生成的是什么格式的文件？
一份结构完整、可下载的文档（Word 或 PDF），不只是对话里的一段文字。
需要准备资料吗？
不准备也可以直接发送，Ofox Chat 会先按模板写出一版。把背景资料、数据或已有文档一起发过去（直接粘贴，或上传 PDF、Word 等文件），写出来会更贴合你的实际情况。
可以修改提示词吗？
可以。提示词会填进 Ofox Chat 的输入框，发送前可以换成你自己的主题、补充要求，或删掉不需要的部分。
提示词可以直接复制使用吗？
可以。点提示词卡片右上角的「复制」即可得到纯文本，也能用在其他 AI 写作工具里。
更多同类
更多研发提示词- 技术方案设计说明一个系统或功能如何实现：架构、数据模型、接口与备选方案对比，并评估性能、风险与发布回滚。研发
- 故障复盘报告按时间线还原一次线上故障，量化影响范围，追查根因，制定有负责人和期限的改进项，避免同类问题再次发生。研发
- 技术选型报告围绕业务需求设定评估维度与权重，对比候选技术并结合验证数据打分，给出推荐方案、风险与落地计划。研发
- 测试计划为一个版本或项目明确测什么、怎么测、在什么环境测、什么时候算测完，对齐测试、研发与产品的预期。研发
- 上线发布手册把一次上线拆成可以逐步执行的手册：发布前检查、操作步骤、上线后验证，以及触发条件明确的回滚方案。研发
- 编码规范为团队制定统一的编码规范：规则按必须与推荐分级，覆盖命名、代码组织、错误处理、安全编码与评审，每条附正反例。研发
- 数据库设计文档写清系统的数据层设计：ER 关系、表结构与约束、每个索引对应的查询、数据量预估与归档策略，作为建表与评审依据。研发
- 系统迁移方案规划一次系统或数据迁移：盘点现状、选定迁移策略，写清数据同步与校验、灰度切换步骤以及每个阶段的回滚方案。研发
- 性能测试报告汇总一次性能测试：对照目标给出各场景的吞吐、响应时间分位数与资源使用，定位瓶颈，判断能否上线并给出容量建议。研发
- 安全评估报告对一个系统做安全评估并成文：界定范围、做威胁建模，逐条记录发现的问题与风险等级，给出修复建议和复测计划。研发
有自己的想法？直接开始创作
在 Ofox Chat 里用一句话描述你想要的画面，从零生成属于你的作品。