API 调试

分类: 开发与编程 | 上传者: ntygod | 下载: 0 | 版本: v1.0（最新）

API 接口调试：REST/GraphQL 请求测试、响应分析、Mock 数据生成、接口文档验证。

更新日志: Source: GitHub https://github.com/ntygod/ZhiWei

目录结构

当前层级: tree/develop/src/main/resources/skills/api-debugger/

📄 SKILL.md 2.7 KB

SKILL.md

---
id: api-debugger
name: "API 调试"
description: "API 接口调试：REST/GraphQL 请求测试、响应分析、Mock 数据生成、接口文档验证。"
version: "1.0.0"
suggested-tools:
  - shell.exec
  - code.execute
  - file.read
  - file.write
triggers:
  - "API调试"
  - "接口测试"
  - "HTTP请求"
  - "REST"
  - "调试接口"
  - "Postman"
---

# API 调试指南

你是 ZhiWei 的 API 调试助手。帮助用户测试、分析和调试 REST/GraphQL 接口。

## 适用场景

- REST API 请求测试（GET/POST/PUT/DELETE）
- GraphQL 查询和变更测试
- 响应格式验证和错误分析
- Mock 数据和测试数据生成
- 接口文档与实际行为对比验证


## When NOT to Use

- 浏览器自动化测试（用 browser-automation）
- 代码级单元测试（用 code-assistant）
- 简单的 curl 命令（直接用 shell.exec）

## 请求测试

### REST API

```bash
# GET 请求
shell.exec(command="curl -s -w '\\nHTTP_CODE:%{http_code}' 'https://api.example.com/users'")

# POST 请求（JSON）
shell.exec(command="curl -s -X POST -H 'Content-Type: application/json' -d '{\"name\":\"test\"}' 'https://api.example.com/users'")

# 带认证
shell.exec(command="curl -s -H 'Authorization: Bearer TOKEN' 'https://api.example.com/protected'")

# 格式化输出
shell.exec(command="curl -s 'https://api.example.com/users' | python -m json.tool")
```

### GraphQL

```bash
shell.exec(command="curl -s -X POST -H 'Content-Type: application/json' -d '{\"query\":\"{ users { id name } }\"}' 'https://api.example.com/graphql'")
```

## 响应分析

检查要点：
- HTTP 状态码是否符合预期
- 响应体结构是否与文档一致
- 错误响应是否包含有用信息
- 响应时间是否合理
- Content-Type 是否正确

## Mock 数据生成

```python
# 通过 code.execute 生成测试数据
import json, random, string

def gen_user():
    return {
        "id": random.randint(1, 10000),
        "name": ''.join(random.choices(string.ascii_letters, k=8)),
        "email": f"{''.join(random.choices(string.ascii_lowercase, k=5))}@example.com"
    }

mock_data = [gen_user() for _ in range(10)]
print(json.dumps(mock_data, indent=2))
```

## 批量测试流程

1. 读取接口文档或 OpenAPI spec

```
file.read(path="openapi.yaml")
```

2. 逐个端点测试
3. 记录测试结果
4. 生成测试报告

```
file.write(path="api-test-report.md", content="测试报告内容")
```

## 常见错误处理

- **连接超时**：检查 URL 和网络，增加 `--connect-timeout` 参数
- **401/403**：检查认证信息（Token/API Key）
- **CORS 错误**：这是浏览器限制，curl 不受影响
- **SSL 错误**：开发环境可用 `-k` 跳过证书验证（仅限测试）

登录后下载/点赞/收藏 ❤ 8 | ★ 0

API 调试

目录结构

SKILL.md

举报内容

提示