1.ai文档接口生成提示词

ai生成的接口提示词

请根据我提供的服务功能、接口代码、接口文档或业务说明，生成一份用于“其他服务集成该功能/接口”的 Markdown 说明文档。 文档目标： - 让其他服务的开发人员可以快速理解该功能/接口的用途、调用方式、参数要求、返回结果和异常处理。 - 文档应面向服务集成场景，而不是面向最终用户。 - 内容要清晰、结构化、可直接放入项目文档中。 请按以下结构生成：# XX功能/接口集成说明## 1. 功能概述说明该功能/接口解决什么问题，适用于哪些业务场景。## 2. 接入前提说明调用方需要满足的条件，例如： - 是否需要鉴权 - 是否需要配置服务地址 - 是否依赖特定环境、账号、权限、开关或数据准备## 3. 接口说明如果是接口，请包含： - 接口名称 - 请求方式 - 请求路径 - Content-Type - 是否需要鉴权 - 接口说明## 4. 请求参数使用表格说明参数：|参数名|类型|是否必填|示例值|说明||---|---|---|---|---|如果存在 Header、Path、Query、Body 参数，请分开说明。## 5. 请求示例提供完整请求示例，例如 curl、JSON 或伪代码。## 6. 返回结果说明成功返回结构，并使用表格解释字段：|字段名|类型|示例值|说明||---|---|---|---|## 7. 返回示例提供成功响应 JSON 示例。## 8. 异常说明列出常见错误码、错误信息和处理建议：|错误码|错误信息|可能原因|处理建议||---|---|---|---|## 9. 集成流程用步骤说明其他服务如何完成集成，例如：1. 配置服务地址2. 获取鉴权信息3. 组装请求参数4. 调用接口5. 处理返回结果6. 处理异常场景## 10. 注意事项说明调用限制、幂等性、超时时间、重试策略、数据一致性、兼容性、字段枚举值等。## 11. 示例代码如信息足够，请提供调用示例代码。优先使用 Java / JavaScript / Python 中最适合当前场景的一种。## 12. FAQ整理集成方可能遇到的常见问题。 输出要求： - 使用中文。 - 使用标准 Markdown 格式。 - 表格字段要完整。 - 如果我提供的信息不足，请不要编造，使用“待补充”标记。 - 如果能从上下文推断，请明确写出“根据现有信息推断”。 - 文档风格应专业、简洁、适合内部技术文档。 以下是需要生成文档的功能/接口信息： 【在这里粘贴服务功能说明、接口代码、Controller 方法、OpenAPI 文档、接口入参出参、业务规则等】