Trae做接口文档时提示词应该怎么写

大伟君_1918

大伟君_1918

2026-06-20

919人浏览

原创

你是一名资深后端API文档工程师,熟悉OpenAPI 3.0规范,只输出符合该规范的YAML格式文档;需以源码为准,严格按paths→components.schemas→tags→info顺序输出,禁用解释性文字,精准映射注解与字段约束。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

trae做接口文档时提示词应该怎么写

用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”。

Trae mac
Trae mac

Trae Mac 官方版本现已全面适配 Apple Silicon(M1/M2/M3等)与 Intel 芯片,要求 macOS 12.0 及以上系统。国内开发者可直接访问 Trae 中文官网(trae.cn 或 trae.com.cn)下载专属 .dmg 安装包,享受国内直连的极速稳定体验。

下载

方法二:禁用自由发挥项
追加指令:“禁止输出任何解释性文字、注释、‘注意’说明、示例curl命令、HTTP状态码说明表;不生成security、servers、x-*扩展字段”。

精准约束字段行为

对请求体字段,写:“DTO中被@NotNull标注的字段,在schema中设required;@NotBlank字符串字段加minLength: 1;LocalDateTime字段type设为string,format设为date-time;List字段items引用对应components.schemas中的定义,不内联”。

对响应体字段,写:“只根据DTO的getter方法推导字段,忽略private字段和lombok的@Data未暴露字段;Boolean类型字段命名含isXXX的,YAML中字段名保持isXXX,不要自动转成xxx”。

关键提醒:【如果DTO用了@ApiModelProperty(value="用户昵称"),必须把value值作为schema字段的description,而不是Java变量名】

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

trae

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Trae AI 编程助手入门与开发实战专题
Trae AI 编程助手入门与开发实战专题

Trae AI编程助手入门与开发实战专题,字节跳动推出的国内首款AI原生集成开发环境(IDE),基于VS Code架构打造,完美兼容主流插件生态。本专题系统梳理Trae三大核心模式:IDE模式覆盖日常编码与代码补全,SOLO模式实现从自然语言需求到完整项目的全自动开发,Builder模式一键生成规范项目框架。专题涵盖从环境搭建、精准Prompt编写、MCP工具配置到Agent智能体调度的完整工作流,结合景区订票系统、Spring Boo

2026.05.20

348

10

Trae AI Agent 与自动化工作流开发专题
Trae AI Agent 与自动化工作流开发专题

Trae AI Agent 与自动化工作流开发专题,深入解析字节跳动Trae IDE中智能体(Agent)系统的架构设计与实战应用。本专题聚焦Trae内置的Chat、Builder、SOLO三大智能体角色,详解如何通过MCP协议打通GitHub、Figma、高德地图等200+外部服务,实现从需求解析、架构设计、代码生成到测试部署的全链路自动化。专题涵盖多智能体协作模式——Agents as Tools、Workflow、Graph与Sw

2026.05.20

384

10

Trae 模型配置与AI编程生态专题
Trae 模型配置与AI编程生态专题

Trae 模型配置与AI编程生态专题,字节跳动Trae IDE作为国内首款AI原生开发环境,支持Claude Sonnet、GPT-4o、DeepSeek、豆包等主流大模型自由切换。本专题系统讲解Trae国内版与国际版的模型配置差异:国内版默认搭载豆包与DeepSeek模型,完全免费且无调用次数限制;国际版支持接入OpenAI与Anthropic官方API Key,满足海外开发者需求。

2026.05.20

230

10

Tailwind CSS 如何制作导航栏和卡片
Tailwind CSS 如何制作导航栏和卡片

用 Tailwind CSS 制作导航栏和卡片,可先搭建语义化结构,再组合 Flex、Grid、间距、圆角与阴影类。这里整理横向导航、移动端菜单、卡片网格及悬停效果的相关文章,帮助你把常见页面组件做得清晰且适配不同屏幕。

2026.11.03

0

17

Tailwind CSS 响应式布局怎么写
Tailwind CSS 响应式布局怎么写

Tailwind CSS 响应式布局通常从移动端样式写起,再用 sm、md、lg 等前缀调整不同屏幕宽度下的网格、间距和导航。本专题整理断点配置、Grid 与 Flex 自适应布局及常见溢出问题,帮助你逐步完成多设备适配。

2026.11.03

0

19

Tailwind CSS 常用类名怎么记
Tailwind CSS 常用类名怎么记

Tailwind CSS 类名很多,先按布局、间距、文字、颜色和状态分组记忆,再通过官方文档检索具体写法。本专题结合类名排序、动态拼接失效、自定义实用类等问题,帮助你建立常用类名的速查方法。

2026.11.03

0

12

码上飞入口地址合集
码上飞入口地址合集

本专题汇总了码上飞(CodeFlying)的官方入口地址合集,涵盖官网主站及网页版在线使用入口,支持注册登录后直接在线体验零代码AI应用生成。同时整理了APP端下载渠道与小程序入口,助你快速访问平台,通过自然语言描述需求即可生成应用、小程序或网站。

2026.11.03

0

10

Uvicorn 报错与问题解决教程
Uvicorn 报错与问题解决教程

本专题汇总了Uvicorn服务器常见问题与报错解决的教程合集,涵盖启动失败、端口占用、模块导入错误、事件循环冲突及热重载失效等典型故障的排查思路。同时整理了多进程与Worker配置、SSL/HTTPS证书报错、跨域与代理配置等实战解决方案,助你快速定位并解决Uvicorn运行中的各类问题。

2026.11.02

20

14

Uvicorn使用教程
Uvicorn使用教程

本专题汇总了Uvicorn使用教程与启动运行指南,涵盖其作为Python ASGI服务器的定位与特点,以及命令行启动(uvicorn main:app --reload)、参数配置(host/port/workers)、程序内嵌运行与Gunicorn结合部署等核心用法。同时整理了热重载调试、日志配置与生产环境部署优化等技巧,助你快速掌握Uvicorn的运行与配置。

2026.11.02

20

17

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程