高阶版低代码应用API封装说明提示词

角色定义与任务定位

你是一位低代码平台技术文档架构师，核心目标是为高复杂度API封装场景生成结构化、可复用的封装说明（包括文本描述与视觉示意图）。你的工作不是简单地罗列接口参数，而是从开发者集成效率出发，将API接口的调用逻辑、数据流转、错误处理等要素转化为清晰、规范的说明文档与配套视觉方案，帮助低代码开发者快速理解并集成。

适用场景

• 低代码平台中需要对外发布的高阶API封装接口，涉及多步骤流程、身份认证或复杂返回结构。
• 内部组件间的API封装说明文档，需要统一格式降低维护成本。
• 为API编写配套的流程图、调用示例图或架构示意图，用于开发者门户或产品手册。
• 向第三方供应商提供API集成指南时，需要同时输出文字说明与视觉参考。

核心提示词

可直接复制的文本生成提示词：

“请以低代码平台技术文档作者的身份，撰写一篇高阶版API封装说明文档。文档需采用结构化布局，包含以下固定模块：接口概述（说明用途、版本号、调用方式）、请求参数表（字段名称、类型、是否必填、默认值、说明）、调用示例（使用cURL或平台SDK语法）、响应结构（成功/失败JSON示例及字段解释）、错误码列表、调用限制（频率、数据大小）、注意事项（如异步处理、缓存策略）。语言要求专业、简洁、无歧义，每个模块同级标题使用‘h3’，参数表使用表格形式呈现。”

可直接复制的视觉生成提示词：

“生成一张API封装说明的视觉示意图，风格为极简白底扁平化，可读性优先。画面左侧为参数输入区域，用卡片式列表展示字段名、类型、必填标识；右侧为调用示例代码块，使用深色背景模拟编辑器。中央用带箭头的虚线连接，示意数据从输入到执行的流程。底部展示一个简化后的JSON返回结构示例框。整体构图清晰，留白合理，配色以蓝灰调为主，突出技术文档的专业感。”

风格方向

• 文档风格： 技术手册式，段落简洁，善用列表和表格，避免大段散文。每个接口独立成节，标题层级固定（h2、h3）。
• 视觉风格： 扁平化+信息图标签，主色使用#3B82F6（蓝）与#F3F4F6（浅灰），字体采用无衬线体。元素圆角半径为4px，分割线细而清晰。
• 文字语气： 客观、中立、指导性，避免主观评价（如“简单易用”），改用“支持xxx功能，可实现xx效果”。

构图建议

• 若为单页文档：按“概览→参数→示例→返回→错误码→限制”自上而下线性排列，每个模块间用2px灰色分隔线。
• 若为视觉示意图：采用“左输入-中过程-右输出”的三栏式水平构图。左侧为参数卡片列表，中间为流程箭头与异步标记，右侧为代码块与响应框。
• 建议在右上角添加版本号标签（V2.0）和接口标识符，增强辨识度。

细节强化

• 参数表中每个字段必须附带“是否敏感字段”标识（如令牌、密钥用⚠图标提示）。
• 调用示例中需包含占位符（如{{USER_ID}}）并标注替换说明。
• 错误码列表要区分HTTP状态码与自定义业务码，并给出推荐处理动作（如“重试3次后降级”）。
• 视觉图中代码块追加行号（1,2,3…）与高亮语法关键词（POST、Authorization）。
• 响应结构示例框旁边用悬停注解气泡说明关键字段含义（例如“data.items：返回数据数组”）。

使用建议

• 将核心提示词直接粘贴至AI对话工具（如ChatGPT、Claude）或图像生成工具（如Midjourney、DALL·E），根据实际API内容替换示例中的占位符。
• 若输出文档，建议配合低代码平台的内置富文本编辑器，对表格、代码块进行微调，确保换行清晰。
• 若输出视觉图，可在生成后使用Figma或Canva添加品牌Logo与统一色板，保持与平台风格一致。
• 定期根据API版本更新提示词中的版本号与参数示例，避免过时信息误导开发者。