api-development

专业版增强能力

功能能力

• Meta-skill that orchestrates the full API development lifecycle — from
  design through documentati

快速入门指南

1. 确认运行环境满足依赖说明中的要求
2. 在AI Agent对话中调用本技能,提供必要的输入参数
3. 检查输出结果,根据需要进行后续处理

> 详细的输入输出格式请参考下方章节说明。

应用场景

不适用于：需要人工判断的复杂决策场景

使用方法

1. 构建API请求: 根据用户输入组装API请求参数与请求头
2. 调用服务接口: 发送HTTP请求到目标服务端点,处理响应或超时
3. 解析响应数据: 提取API返回的关键字段,转换为用户可读格式
4. 异常处理: 如遇错误,参考错误处理章节中对应场景的处理方式

请求格式

输出规范

{
  "success": true,
  "data": {
    "final_result": {
      "development_result": "development_result_value",
      "development_metadata": "development_metadata_value",
      "development_status": "development_status_value"
    },
    "execution_log": [
      {
        "step": 1,
        "name": "按流程执行",
        "status": "completed",
        "duration_ms": 1200,
        "output_summary": "按流程执行"
      },
      {
        "step": 2,
        "name": "按流程执行",
        "status": "completed",
        "duration_ms": 3500,
        "output_summary": "按流程执行"
      },
      {
        "step": 3,
        "name": "按流程执行",
        "status": "completed",
        "duration_ms": 2100,
        "output_summary": "按流程执行"
      },
      {
        "step": 4,
        "name": "按流程执行",
        "status": "completed",
        "duration_ms": 800,
        "output_summary": "按流程执行"
      }
    ],
    "total_duration_ms": 7600,
    "gates_passed": 3,
    "gates_total": 3
  },
  "error": null
}

中间产物模板参考: assets/api-development_template

异常管理

前置条件

运行环境

• Agent平台: 支持SKILL.md的任意AI Agent(Claude Code / Cursor / Codex / Gemini CLI等)
• 操作系统: Windows / macOS / Linux

依赖说明(补充)

API Key 配置

可用性分类

• 分类: MD+execute()
• 说明: 基于Markdown的AI Skill,

API Key配置方式:

export API_KEY="${API_KEY:?请设置环境变量}"

配置后需重启会话或开启新终端生效。API Key应妥善保管,避免泄露到版本控制系统.

热门问题

Q1: 如何开始使用api-development？

A: 请参考使用流程和依赖说明章节，确保运行环境满足要求后调用本技能。

错误处理体系

功能边界

• 需要API Key，无Key环境无法使用

常见问题FAQ

Q1: 如何在API开发工具中定义API端点？

A: 在API开发工具中，您可以通过配置文件或直接在代码中定义API端点，包括URL、HTTP方法、请求参数等。

Q2: API开发工具支持哪些类型的API文档生成？

A: API开发工具支持多种类型的API文档生成，包括Markdown、Swagger、OpenAPI等格式。

Q3: 如何在API开发工具中实现API测试？

A: API开发工具提供了内置的测试功能，允许您通过编写测试脚本或直接在工具中执行测试用例来验证API功能。

Q4: API开发工具如何处理API权限和认证？

A: API开发工具支持多种权限和认证机制，如OAuth 2.0、API密钥、JWT等，您可以在配置中设置相应的认证方式。

Q5: 在API开发过程中，如何确保API的安全性？

A: API开发工具提供了多种安全特性，如输入验证、数据加密、API速率限制等，以确保API在开发和使用过程中的安全性。

诊断与修复

安全责任声明

创新亮点

请注意，以上内容仅为示例，具体内容应根据API开发工具的实际功能和特性进行调整。

功能速览

• 自动化执行: 编排API全生命周期,从设计到文档/测试/部署一站完成,规范产出API。Meta-skill that orchestr
• 文件处理: 支持多种文件格式的读取、解析和写入操作
• API集成: 通过标准化接口调用外部服务并处理响应
• 命令执行: 在安全沙箱中执行系统命令并收集结果

量化评估

优势对比