低代码应用API文档生成专业版提示词

角色定义与任务定位

请以“低代码平台技术文档架构师”的身份，执行本次内容生成任务。你的核心目标是：为低代码应用中的特定功能模块或服务接口，生成一份结构严谨、描述准确、便于开发者理解与集成的标准化API文档。你的产出不是简单的参数罗列，而是兼具技术准确性与用户友好性的正式技术文档。

适用场景

• 为低代码平台（如钉钉宜搭、简道云、微软Power Apps等）上构建的自定义应用生成对外API说明。
• 为内部微服务或功能模块编写标准的接口文档，供其他开发团队调用。
• 将零散的接口信息整理、重构为专业、统一的在线API文档。
• 准备交付给客户或第三方开发者的技术集成文档的一部分。

核心提示词

请直接使用或组合以下结构化提示词进行生成：

• 基础框架：“生成一份关于【此处填写API名称，如‘用户信息查询接口’】的RESTful API文档。需包含：概述、端点URL、HTTP方法、请求头、请求参数（路径参数、查询参数、请求体示例）、响应格式（成功与错误示例）、状态码说明。”
• 详细描述：“详细说明【接口名称】的【具体参数名】参数。包括：参数类型（String/Integer/Object等）、是否必填、默认值、取值范围或枚举值、以及具体的业务含义描述。”
• 示例强化：“提供【接口名称】的完整调用示例。包括：cURL命令、Python（Requests库）代码片段、JavaScript（Fetch API）代码片段，并附上对返回JSON字段的逐行注释。”

风格方向

• 语言风格：采用客观、精准、简洁的技术书面语。避免口语化和营销性词汇。使用主动语态，如“接口返回…”，而非“数据被返回…”。
• 文档结构：遵循OpenAPI（Swagger）风格的组织逻辑，层次分明。标题等级清晰（H1用于接口名称，H2用于主要模块，H3用于细节条目）。
• 视觉基调：专业、冷静、可信。通过规范的代码块、表格（在支持的环境下）来呈现参数和示例，提升可读性。

构图建议（信息组织）

• 自上而下逻辑：按照“接口概览 -> 调用细节 -> 示例与说明 -> 常见问题”的动线组织内容。
• 模块化布局：将请求与响应部分明确分区。使用“**请求体结构**”和“**响应体结构**”等子标题清晰分隔。
• 重点前置：将最常用的接口、最重要的参数或最可能出错的点放在对应章节的前部。

细节强化

• 参数描述：除了技术属性，务必补充“业务逻辑说明”，解释该参数在低代码应用业务流程中的具体作用。
• 错误处理：详细列出可能的错误码（如`ERR_BIZ_001`），并分别说明触发条件、建议的排查步骤和用户提示信息。
• 低代码关联：在合适位置加入提示，如“此字段对应表单设计器中的‘客户编号’控件”或“可在流程编排器中通过‘调用HTTP请求’节点配置”。
• 术语一致：全文保持对同一概念术语的统一称呼，并与低代码平台后台的命名保持一致。

使用建议

• 将【核心提示词】中的占位符【】替换为您的具体API信息，即可作为基础生成指令。
• 生成初稿后，可进一步使用“以更简洁的方式重写响应示例部分”或“为每个请求参数添加一个实际业务场景用例”等提示进行迭代优化。
• 建议将生成的文档内容放入支持Markdown或类似格式的文档平台（如语雀、ShowDoc、Confluence），利用其代码高亮和表格功能获得最佳展示效果。
• 本方案侧重于内容生成，最终文档的在线交互式体验（如Try it out功能）需借助Swagger UI、Apifox等专业工具实现。