必须以「请求URL」「请求方法」「请求头」「请求体(JSON Schema)」「响应体(JSON Schema)」为一级标题骨架,字段用括号注释或表格说明,仅输出标准OpenAPI 3.0 YAML片段,严格对齐真实报文字段粒度与嵌套深度。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你在MarsCode里写接口对接说明时,提示词生成的文档东一句西一句、逻辑断层、字段解释和调用示例混在一起,根本没法直接给后端或测试同学用。
先锁定核心信息结构
打开MarsCode的提示词编辑框,把当前零散的描述全删掉。不要从“这个接口是干嘛的”开始写,而是【必须以「请求URL」「请求方法」「请求头」「请求体(JSON Schema)」「响应体(JSON Schema)」为一级标题骨架】,其他内容一律往这五个桶里塞。
如果漏掉请求头里的Authorization类型,下游调用必然401;如果响应体没标status字段是否必返,联调时就会卡在空指针异常上。
用「字段级锚点」替代段落式描述
方法一:在请求体JSON Schema中,每个字段后面紧跟括号注释,格式统一为"字段名(类型|是否必填|说明|示例值)"。
比如:"user_id(string|必填|用户全局唯一ID,长度32位,由OAuth2.0服务颁发|"usr_8a7f3b1e9c2d4a5f8b6c1d2e3f4a5b6c")"。
方法二:把所有字段说明抽成表格,表头固定为「字段名|位置(path/query/body)|类型|必填|说明」,表格嵌在「请求体」和「响应体」二级标题下。注意表格里不要出现「见上文」这类指向性文字——MarsCode生成时会丢上下文。
强制绑定真实调用链路
第一步:在提示词开头明确写死本次生成目标:【仅输出标准OpenAPI 3.0 YAML片段,不含任何解释性文字、不包含summary/description字段、不生成x-扩展字段】。
第二步:在提示词末尾追加约束条件:“若请求体含嵌套对象,每一层object必须带required数组;若响应体有code/message/data三字段结构,data字段schema必须精确到三级属性”。
第三步:粘贴一段你线上已验证通过的真实请求/响应报文(脱敏后),在提示词里标注「以此为准」——MarsCode会优先对齐这段样本的字段粒度和嵌套深度,而不是自由发挥。

















