用途
该技能用于自动化 API 端点测试,覆盖 REST 与 GraphQL 两类接口。它面向需要生成、执行并校验 API 测试的场景,目标是实现请求生成、响应验证和较全面的测试覆盖。
主要能力
- 解析 API 定义:可解析提供的 API 定义(如 OpenAPI/Swagger 文件、代码文件),或从使用情况中推断 API 定义。
- 生成测试用例:基于 API 定义创建覆盖不同场景的测试用例,包括 CRUD 操作、认证和错误处理。
- 执行测试并校验响应:执行生成的测试,并针对预期的状态码、响应头和响应体结构校验响应。
- 契约测试:依据 OpenAPI 规范执行契约测试。
- 认证流程测试:覆盖多种认证方式,可测试登录、刷新令牌以及受保护端点等认证流程。
- GraphQL 测试:为 GraphQL API 创建覆盖查询(queries)、变更(mutations)和订阅(subscriptions)的测试。
使用方式
该技能在以下需求出现时激活:
- 为 REST 端点生成全面的 API 测试。
- 创建覆盖查询、变更和订阅的 GraphQL API 测试。
- 依据 OpenAPI/Swagger 规范验证 API 契约。
- 测试 API 认证流程,包括登录、刷新和受保护端点。
示例一:生成 REST API 测试。用户请求“为 src/routes/users.js 中的用户管理端点生成 API 测试”,技能会分析指定文件中的用户管理端点,并生成覆盖用户资源 CRUD 操作(创建、读取、更新、删除)的测试套件。
示例二:创建 GraphQL API 测试。用户请求“为产品查询和变更创建 GraphQL API 测试”,技能会分析 GraphQL schema 中的产品查询和变更,并生成测试以验证这些操作的功能和数据完整性。
适用场景
- 需要为 REST 端点批量生成测试用例的项目。
- 需要为 GraphQL 的查询、变更、订阅编写测试的项目。
- 需要依据 OpenAPI/Swagger 规范进行契约验证的项目。
- 需要验证登录、令牌刷新和受保护端点等认证流程的项目。
最佳实践
- API 定义:提供清晰准确的 API 定义(如 OpenAPI/Swagger 文件),以获得最佳的测试生成效果。
- 认证细节:明确访问 API 端点所需的认证方式和凭据。
- 上下文信息:提供 API 用途和使用方式的上下文,以引导测试生成过程。
集成
该技能可与其他插件集成,从代码仓库或 API 网关等多种来源获取 API 定义;也可与报告工具结合,生成详细的测试报告和仪表盘。
限制
资料未提供该技能的具体安装命令、支持的运行环境、收费方式与价格、性能指标或效果保证等信息,暂未提供。