云原生平台API文档生成清晰框架提示词
面向云原生平台API文档设计,从架构师视角提供一套可直接用于视觉生成的提示词方案,聚焦清晰框架、层次结构与开发者体验,助力快速产出专业级文档界面或示意图。
云原生平台
API文档
文档生成
提示词内容
可直接复制使用
角色定义 你是一位云原生API文档架构师,核心任务是设计一套层次清晰、逻辑连贯的API文档视觉框架,帮助开发者一眼理解接口调用关系、数据流动与模块划分。你需要以提升开发者体验为目标,将技术规范转化为直观的视觉语言,确保框架兼具标准化与可复用性。 适用场景 云原生平台API参考文档的页面布局设计 微服务架构下API端点目录的可视化呈现 API文档框架的UI稿或示意图生成(用于产品演示或宣传材料) 内部开发者门户中API文档模板的标准化设计 核心提示词 以下提示词可直接复制使用,组合后可生成一个完整的API文档框架视觉方案: 主体元素:微服务图标(轻量化、几何风格)、API端点列表(使用RESTful方法色标:GET绿、POST蓝、PUT橙、DELETE红)、参数表格(字段名、类型、必填/可选标识)、响应示例框(代码片段高亮) 结构布局:分层架构图(上方API网关,中间服务集群,下方数据库/缓存),左侧目录树,右侧内容面板(或从上到下依次为:概述、认证、资源、错误码) 色彩体系:科技蓝(#1E90FF)为主色,墨绿(#2E8B57)用于状态成功,深灰(#333)作为文字主色,浅灰(#F5F5F5)作为卡片背景 视觉语言:网格对齐、圆角卡片、细线连接(箭头指示调用方向)、阴影层次(Z轴暗示页面层级) 文字规范:等宽字体(如Roboto Mono)用于代码与端点路径,无衬线字体(如Inter)用于标题与说明,字号梯度16/14/12px 风格方向 现代极简:大量留白、去除冗余装饰、强调内容可读性 技术理性:严整的网格系统、统一的图标风格、色彩克制 层级清晰:通过大小、颜色、阴影区分标题、端点、参数、示例的优先级 构图建议 横向三分式:左侧窄列(目录 + 快速跳转),中间主区域(API详情),右侧可选栏(相关链接 / 版本切换) 纵向瀑布流:从上至下依次为API名称与描述 → 请求方法及URL → 请求头/参数表格 → 请求体示例 → 响应体示例 → 错误码说明 中心辐射式(适用于微服务架构总览):API网关位于中心,各微服务以模块形式向外排列,每个模块内列出关键端点 细节强化 端点卡片中的HTTP方法标签使用小圆角胶囊背景,搭配对应颜色 参数表格中“必填”字段增加星号(红色)或标签徽章 连接线使用虚线表示可选调用关系,实线表示强制依赖 响应示例框添加“复制”图标按钮(hover时亮色反馈) 在框架边缘添加淡入的版本号水印(如v2.1.0),增强文档归属感 使用建议 直接组合核心提示词中的描述,配合风格与构图方向,用于Midjourney/Stable Diffusion生成概念稿(推荐参数:--ar 16:9 --v 6.0 --style raw) 如需产出UI界面,将核心提示词作为DALL·E或Adobe Firefly的文字指令,并附加“高清、界面截图、Figma风格” 构建文档框架模板时,优先采用上述色彩体系与字体规范,可无缝对接Ant Design或Material Design组件库 建议在细节强化中选取2-3条作为差异化亮点,避免一次性堆砌过多导致画面杂乱