后端接口结构化输出模板结果优化提示词

角色定义与任务定位

请以“后端架构师兼技术文档规范制定者”的身份，运用本方案。你的核心目标是：将模糊的“优化接口输出”需求，转化为一套具体、可执行、高质量的提示词指令，用于生成或重构清晰、一致、健壮的后端接口响应模板，确保其具备良好的可读性、可维护性和开发者体验。

适用场景

• 为新开发的API设计初始响应数据结构。
• 重构现有混乱、不一致的接口返回格式。
• 编写或优化API文档中的响应示例部分。
• 制定团队内部接口输出规范时的参考模板。
• 指导大语言模型生成符合特定格式要求的接口代码或文档。

核心提示词

（以下为可直接复制使用的提示词核心部分，请根据具体需求组合调整）

• 基础指令：生成一个遵循RESTful风格、结构清晰的[JSON/XML]响应模板。
• 结构要求：必须包含`code`（状态码）、`message`（提示信息）、`data`（核心数据）及`timestamp`（时间戳）根字段。
• 数据层规范：`data`字段应根据业务类型严格结构化。例如，列表查询应为`{“list”: [], “total”: 0, “page”: 1}`；单一对象应直接包含其属性；分页、排序等元数据需明确。
• 类型与约束：为每个字段明确指定数据类型（如`integer`， `string`， `boolean`， `array` of `object`）并添加必要的注释说明，例如`// 0成功，非0错误`。
• 错误案例：同时提供一个标准的错误响应结构示例，包含常见的错误码和`message`示例。

风格方向

• 极简严谨风：字段命名采用小驼峰（如`userName`），去除任何冗余字段，注释精炼，体现工业级代码的克制与准确。
• 开发者友好风：在响应中增加`path`（请求路径）、`requestId`（请求追踪ID）等调试字段，注释详细，包含示例值，降低对接成本。
• 领域适配风：根据金融、物联网、社交等不同领域，调整数据结构的侧重点。如金融领域强调`amount`（金额）、`currency`（币种）的精度与格式；物联网强调`deviceId`、`sensorData`序列的结构。

构图建议（结构组织）

• 总分总结构：先定义全局响应包装器（`ResponseWrapper`），再详细展开`data`内部的各种业务对象结构（如`UserDTO`， `ProductVO`），最后提供完整的成功与失败用例。
• 层次递进：从最通用的公共字段（`code`， `message`）开始，过渡到业务数据（`data`），最后是扩展信息（`pagination`， `metadata`）。
• 对比呈现：将“优化前”的扁平、混乱结构与“优化后”的层次化、结构化模板并置，直观展示改进点。

细节强化

• 字段语义：确保每个字段名都能清晰表达其含义，避免`obj`， `info`等模糊命名。
• 值域说明：关键字段（如`code`）需枚举所有可能值及其含义（`200: OK`， `404: Not Found`， `5001: 业务校验失败`）。
• 空值处理：明确`data`为空时，应返回`null`还是空对象`{}`、空数组`[]`，保持一致性。
• 扩展性预留：在根节点或`data`内设计可选的`extra`或`_links`（HATEOAS）字段，为未来功能留出扩展空间。
• 安全过滤：提示在输出模板中标注敏感字段（如`password`， `token`）应被脱敏或忽略。

使用建议

• 将“核心提示词”部分作为与大模型对话的起点，结合“风格方向”确定基调。
• 在实际项目中，可根据“细节强化”点逐一检查生成的模板，补充领域特定的约束。
• 此方案输出的是“模板的描述与规范”，而非直接可运行的代码。您需要将其转化为具体的编程语言实现或文档内容。
• 鼓励将最终优化定稿的提示词保存为团队知识库的“接口规范生成模板”，实现标准化复用。