API 文档

API 文档（免费）

技能概述

撰写接口文档：适用于前后端协作、对外开放 API、系统对接场景，解决「接口文档不全、字段说不清、联调反复扯皮」的问题。最终目的：产出可直接套用的 API 文档提示词：用户只需给接口信息，AI 即输出结构完整、可直接交付的 API 文档。本技能内置可直接套用的提示词模板，加载后 AI 按模板工作，无需额外配置。

适用场景

• 撰写接口文档：适用于前后端协作、对外开放 API、系统对接场景，解决「接口文档不全、字段说不清、联调反复扯皮」的问题
• 典型目的：产出可直接套用的 API 文档提示词：用户只需给接口信息，AI 即输出结构完整、可直接交付的 API 文档

调用方式

当用户提出以下类型的需求时，激活本技能：

• "请帮我API 文档"
• "用API 文档的方法处理这个内容"
• "按API 文档模板生成"

激活后，按下方【内置提示词模板】执行：将用户提供的信息填入模板占位处（____），直接输出完整结果；用户未提供的信息保持占位并提示其补充。

内置提示词模板

【角色设定】
你是技术文档工程师，擅长写结构清晰、前后端都能看懂的 API 文档。

【任务】
根据我的信息，帮我写一份 API 接口文档。

【我会提供的信息】
1. 接口列表（接口名/路径/方法）：____
2. 接口功能说明：____
3. 请求参数（名称/类型/必填/说明）：____
4. 响应结构（字段/类型/说明）：____
5. 鉴权方式（如有）：____
6. 错误码定义（如有）：____

【编写要求】
1. 每个接口包含：功能说明 → 请求方法/URL → 请求头 → 请求参数表 → 响应示例 → 错误码表。
2. 参数表：名称/类型/必填/默认值/说明，格式统一。
3. 响应给 JSON 示例（含成功与失败各一例）。
4. 错误码表：码值/含义/处理建议。
5. 附调用示例（curl 或代码片段）。

【输出格式】
一、接口总览表
二、逐接口文档（完整结构）
三、公共约定（鉴权/分页/时间格式）
四、调用示例

请直接输出，不要询问多余信息；信息缺失处用「____」占位。

输出要求

• 严格按模板指定的输出格式分节输出，不省略、不额外发挥。
• 内容真实合规：不编造数据，不确定处标注「需核实」；涉及专业领域以专业来源为准。
• 输出可直接复制使用，缺失信息用 ____ 占位并提示用户补充。

注意事项

• 本技能为免费技能，无支付环节。
• 如需该场景的高阶版提示词与更多玩法，可在本技能基础上要求 AI 深化；高阶版含五步工作流与合规自检。

风险提示

• 本工具输出结果仅供参考，不构成专业意见或收益承诺；重要决策请自行核实并判断。
• 免费工具不提供持续服务保证，具体以 SKILLHub 平台规则为准。

🚀 高阶用法与进阶技巧

1. 多接口文档生成

场景描述： 当你需要为多个接口生成文档时，可以一次性输入所有接口的信息，AI 会按模板批量生成。 参数/步骤：

• 输入：将所有接口的详细信息按模板格式填入，每个接口之间用换行分隔。
• 输出：AI 会逐个输出每个接口的完整 API 文档。

2. 自定义错误码表

场景描述： 在某些项目中，可能需要自定义错误码表。你可以通过输入特定的错误码信息，AI 会根据模板生成详细的错误码文档。 参数/步骤：

• 输入：提供自定义的错误码、含义和处理建议。
• 输出：AI 会生成一个包含所有自定义错误码的详细表格。

3. 集成调用示例

场景描述： 在某些情况下，你可能需要将 API 文档与具体的调用示例集成在一起。你可以通过输入代码片段或 curl 命令，AI 会将其纳入文档中。 参数/步骤：

• 输入：提供具体的调用示例代码（如 curl 命令或代码片段）。
• 输出：AI 会在文档的调用示例部分展示该代码。

4. 多语言支持

场景描述： 如果你需要生成多语言版本的 API 文档，可以输入不同语言的接口信息，AI 会按模板分别生成每种语言的文档。 参数/步骤：

• 输入：提供不同语言的接口信息，每个语言的信息用换行分隔。
• 输出：AI 会分别为每种语言生成完整的 API 文档。

📋 实战案例（3个真实场景）

案例1：前后端协作

场景描述： 前端开发人员需要与后端对接一个新功能，但后端提供的接口文档不全。使用本工具，可以快速生成清晰的接口文档。 输入示例：

接口列表（接口名/路径/方法）：用户注册 /user/register POST
接口功能说明：用户注册接口
请求参数（名称/类型/必填/说明）：
  - username (string) 必填 用户名
  - password (string) 必填 密码
响应结构（字段/类型/说明）：
  - id (int) 用户ID
  - token (string) 访问令牌

输出要点：

• 生成的文档包含功能说明、请求方法、URL、请求参数表、响应示例和错误码表。
• 可直接复制使用，缺失信息用 ____ 占位并提示用户补充。

案例2：对外开放 API

场景描述： 公司对外提供一个新 API，需要生成详细的接口文档供开发者使用。使用本工具可以快速生成专业且易懂的文档。 输入示例：

接口列表（接口名/路径/方法）：获取用户信息 /user/info GET
接口功能说明：获取用户详细信息
请求参数（名称/类型/必填/说明）：
  - userId (int) 必填 用户ID
响应结构（字段/类型/说明）：
  - id (int) 用户ID
  - username (string) 用户名
  - email (string) 邮箱
鉴权方式：Bearer Token
错误码定义：
  - 401 Unauthorized
  - 404 Not Found

输出要点：

• 生成的文档包含功能说明、请求方法、URL、请求参数表、响应示例和错误码表。
• 可直接复制使用，缺失信息用 ____ 占位并提示用户补充。

案例3：系统对接

场景描述： 两个系统需要对接，其中一个系统提供了 API 接口。使用本工具可以快速生成详细的接口文档，方便另一个系统进行调用。 输入示例：

接口列表（接口名/路径/方法）：支付接口 /payment/pay POST
接口功能说明：处理支付请求
请求参数（名称/类型/必填/说明）：
  - orderId (string) 必填 订单ID
  - amount (float) 必填 支付金额
响应结构（字段/类型/说明）：
  - status (string) 支付状态
  - message (string) 提示信息
鉴权方式：API Key
错误码定义：
  - 400 Bad Request
  - 500 Internal Server Error

输出要点：

• 生成的文档包含功能说明、请求方法、URL、请求参数表、响应示例和错误码表。
• 可直接复制使用，缺失信息用 ____ 占位并提示用户补充。

💰 价值对比（为什么这个工具值得用）

1. 提高效率

与纯手工编写相比，本工具可以显著提高文档生成的效率。只需提供接口相关信息，AI 即可自动生成结构完整、格式统一的 API 文档，节省了大量时间和精力。

2. 减少错误

相比通用 AI 直接问，本工具内置了专门针对 API 文档的提示词模板，确保输出结果符合标准。这样可以减少因模板不匹配导致的格式错误和信息遗漏问题。

3. 提升质量

本工具生成的文档结构清晰、前后端都能看懂，满足不同角色的需求。相比普通文档，更有助于提高开发效率和系统稳定性。

🎯 使用场景与适用人群

适用人群

• 前后端开发人员：需要快速生成接口文档进行协作。
• API 开发者：对外提供 API 接口时，需要生成详细的文档供开发者使用。
• 系统集成工程师：需要对接不同系统时，生成清晰的接口文档。

使用场景

• 前后端协作：解决接口文档不全、字段说不清的问题。
• 对外开放 API：为用户提供详细、标准的 API 文档。
• 系统对接：帮助不同系统快速实现接口调用。

相关推荐