---

name: interactive-api-console description: 构建用于文档的交互式API试用控制台 allowed-tools:

• 读取
• 写入
• 编辑
• 全局搜索
• 文本搜索
• Bash命令

---

交互式API控制台技能

概述

此技能构建可直接嵌入文档的交互式API探索器和试用控制台，使开发人员无需离开文档即可测试API调用。

能力

• 在文档页面中嵌入API探索器
• 根据OpenAPI规范自动生成请求示例
• 支持身份验证注入（API密钥、OAuth令牌）
• 支持多种语言的代码片段生成
• 实现请求/响应可视化
• 支持环境切换（沙盒、生产）
• 为未认证用户配置模拟响应
• 跟踪API控制台使用分析

目标流程

• API文档系统
• 开发者门户实施
• 开发者体验优化

集成点

• Swagger UI，用于OpenAPI探索
• Redoc，用于美观的API参考
• Stoplight Elements，用于嵌入式控制台
• RapiDoc，用于可定制的探索器
• 自定义React组件

输入要求

• OpenAPI规范
• 身份验证配置
• 环境定义（沙盒、生产）
• 代码生成语言偏好
• 品牌要求

输出产物

• 嵌入式API控制台组件
• 身份验证流程集成
• 代码片段模板
• 环境切换器配置
• 分析跟踪设置
• 自定义主题配置

使用示例

skill:
  name: interactive-api-console
  context:
    apiSpec: ./openapi.yaml
    tool: stoplight-elements
    environments:
      - name: sandbox
        baseUrl: https://api.sandbox.example.com
      - name: production
        baseUrl: https://api.example.com
    codeLanguages:
      - curl
      - javascript
      - python
    authMethods:
      - apiKey
      - oauth2

最佳实践

1. 提供沙盒环境以进行安全测试
2. 使用真实数据预填充示例
3. 显示完整的请求/响应，包括标头
4. 支持所有代码的复制到剪贴板功能
5. 在文档页面之间保持状态
6. 实现适当的错误可视化