智能体开发API封装说明结果优化提示词

角色定义

你是一位API文档架构师与技术信息可视化专家，专注于为智能体开发场景中的API封装说明提供结构化、可读性强的呈现方案。你的核心目标是将原本零散或晦涩的接口封装信息（包括端点、参数、返回值、错误码等）转化为层级清晰、便于开发者快速理解的视觉或文本输出，并保持技术严谨性与设计一致性。

适用场景

• 智能体开发过程中，API封装说明的文档页面或截图优化
• 接口调用流程、参数列表、返回值结构的可视化展示
• 开发者门户或API参考文档中的核心模块设计
• 对外技术白皮书、产品演示中涉及封装说明的章节配图
• 内部团队知识库中API接口说明的标准化输出

核心提示词

以下提示词可直接复制使用，用于生成优化后的API封装说明示意图或参考排版：

• “生成一张API封装说明的结构化示意图，包含标题区、方法列表（GET/POST/PUT/DELETE）、请求路径、请求头示例、参数表格（名称、类型、必填、描述）、响应体结构（JSON格式化展示）、错误码说明。整体采用深色科技风背景（#1a1a2e为主色），左侧导航栏列出各接口名称，右侧内容区保持清晰分隔线。使用等宽字体展示代码块，并用彩色标签标识HTTP方法（绿GET、蓝POST、橙PUT、红DELETE）。保持充足留白，避免信息拥挤。”
• “设计一个API封装说明的优化排版模板：顶部为模块标题‘智能体对话接口封装说明’，下方依次部署‘概述’（一句话说明）、‘接口地址’（以curl命令形式展示）、‘请求头’（表格形式，含Content-Type、Authorization等）、‘请求体参数’（嵌套JSON结构示例）、‘成功响应’（200状态码下的返回案例）、‘错误响应’（常见错误码及含义）。使用左右两栏布局，左栏占30%放置接口名称与标签，右栏占70%详细展开说明。配色采用蓝色主调（#1e90ff），点缀灰色与白色，字体为系统无衬线字体。”

风格方向

• 科技文档风：深色背景配合亮色文字，强调代码块的对比度，适用于开发者门户。
• 极简结构风：白色背景、灰色边框、清晰分层，适合印刷或PDF导出。
• 交互原型风：模拟网页或App内的API说明卡片，带折叠/展开效果（视觉上使用箭头或加减号图标示意）。
• 信息层级：标题用2-3级字号区分，参数表格用斑马纹，代码示例用圆角背景块。

构图建议

• 纵列优先：顶部为统一的标题与版本号，下方按接口功能模块纵向排列，每个模块用浅色分割线隔开。
• 左导航右详情：左侧固定宽度列出所有接口名称（带方法标签），右侧展示选中接口的完整封装说明。
• 表格+代码块混合：参数部分使用三列或四列表格，响应示例使用带有行号的高亮代码块。
• 标签化核心信息：将HTTP方法、路径参数、必填标记等用彩色标签或徽章突出显示。

细节强化

• 在所有表格前后增加注释行，说明数据类型（string、integer、object、array）和取值范围。
• 为每个响应示例添加状态码标签（例如“200 OK”）并匹配对应的色调（绿色表示成功，红色表示错误）。
• 在参数表格中，使用“必填”/“可选”的视觉标识（如星号或圆点图标），并确保对齐整齐。
• 错误码部分单独成块，建议用图标（如警告三角）配合简短解释文本，避免冗长段落。
• 若包含分页或授权说明，在底部或侧边使用独立的提示框（浅色背景加边框）进行额外说明。

使用建议

• 将核心提示词直接复制到Midjourney、Stable Diffusion或DALL-E 3中生成示意图，或作为Figma/PPT排版的设计参考。
• 当用于实际文档排版时，可将提示词中的布局描述转换为CSS或Markdown样式规则。
• 若需生成不同风格（如白天模式与夜间模式），只需在提示词中调整背景色与字体颜色即可。
• 建议配合真实接口数据（如路径、参数名称）替换示例内容后使用，避免纯占位符。
• 本方案适用于技术写作者、UI/UX设计师、开发团队中负责API文档维护的人员，也可用于产品经理向客户展示封装逻辑。