你是一名资深后端API文档工程师,熟悉OpenAPI 3.0规范,只输出符合该规范的YAML格式文档;需以源码为准,严格按paths→components.schemas→tags→info顺序输出,禁用解释性文字,精准映射注解与字段约束。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

用Trae生成接口文档时,提示词写得不准会导致字段缺失、参数类型错乱、返回示例格式混乱,甚至把POST请求误标为GET。
明确角色与输入源
第一步:在提示词开头固定声明Trae的角色——“你是一名资深后端API文档工程师,熟悉OpenAPI 3.0规范,只输出符合该规范的YAML格式文档”。【不加这句,Trae会自由发挥,生成Markdown或口语化描述】
第二步:直接粘贴原始接口定义,优先使用代码片段而非文字描述。例如贴出Spring Boot的@RequestBody DTO类+@PostMapping注解方法签名,或FastAPI的Pydantic模型+路由函数。
第三步:强制指定输入源可信度。写明“所有字段定义以Java/Python源码为准,忽略接口文档草稿中的模糊描述”。
控制输出结构与粒度
方法一:要求按OpenAPI标准分段输出
在提示词中写:“严格按以下顺序输出:paths→components.schemas→tags→info;每个部分之间空一行;paths中每个接口必须包含summary、description、requestBody(含content.application/json.schema.$ref)、responses.200.content.application/json.schema.$ref”。
方法二:禁用自由发挥项
追加指令:“禁止输出任何解释性文字、注释、‘注意’说明、示例curl命令、HTTP状态码说明表;不生成security、servers、x-*扩展字段”。
精准约束字段行为
对请求体字段,写:“DTO中被@NotNull标注的字段,在schema中设required;@NotBlank字符串字段加minLength: 1;LocalDateTime字段type设为string,format设为date-time;List
对响应体字段,写:“只根据DTO的getter方法推导字段,忽略private字段和lombok的@Data未暴露字段;Boolean类型字段命名含isXXX的,YAML中字段名保持isXXX,不要自动转成xxx”。
关键提醒:【如果DTO用了@ApiModelProperty(value="用户昵称"),必须把value值作为schema字段的description,而不是Java变量名】


















