api-verification
Solid接口验证规范 — 双产物(.http + .cjs)生成 + 自动化执行脚本
AI & Automation 263 stars
34 forks Updated 2 days ago AGPL-3.0
Install
Quality Score: 84/100
Stars 20%
Recency 20%
Frontmatter 20%
Documentation 15%
Issue Health 10%
License 10%
Description 5%
Skill Content
# API Verification Skill
## 职责
在 dev/fix 工作流涉及接口变更时,生成**归档级双产物**并执行验证:
- `.http` — 可执行请求示例(VS Code REST Client 格式)
- `.cjs` — 自动化执行脚本(Node.js)
> 说明:本 Skill 不负责“给前端或调用方看的轻量接口说明”。这类阅读型目标文档由 `dev-docs` 的 `light-api` / `frontend-api` 模式负责。
## 与 test-router 的关系
- `test-router` 负责识别本轮是否存在 API/HTTP 契约变更、归档级接口验证或回归接口探针需求。
- 一旦 TestRoute 判定需要 `api-verification`,本 Skill 的 `.http + .cjs` 双产物和自动化执行规则仍然强制适用。
- TestRoute 只记录验证路线,不替代本 Skill 的接口覆盖清单、断言脚本和执行结果。
## 触发时机
| 工作流 | 触发条件 |
|--------|---------|
| dev | 新增/修改 API 接口 |
| dev-optimization | 优化前(建立基线)和优化后(对比验证) |
| dev-scenario-test | 场景测试基于接口规范 |
| fix | 修复涉及接口行为变更 |
| test-router | TestRoute 判定存在对外 HTTP/API 契约变更、归档级接口验证或接口回归探针 |
## 双产物规范
### `.http` 文件(可执行请求示例)
```http
# <模块名> API 验证请求示例
@baseUrl = http://localhost:3000
@contentType = application/json
@token = replace-with-token-if-required
@language = zh-CN
@userName = test-user
@userEmail = test@example.com
### POST 创建用户
# @description 创建新用户账号
# @expects 201 + 返回体包含 data.id(人工检查提示)
POST {{baseUrl}}/api/users
Content-Type: {{contentType}}
Accept-Language: {{language}}
# 鉴权值默认可按用户要求直写;只有用户 / 项目要求可分享或脱敏时才保留占位变量
Authorization: Bearer {{token}}
{
"name": "{{userName}}",
"email": "{{userEmail}}"
}
###
```
存放:任务目录根 `*-接口验证.http`(dev 需求目录或 fix bug 目录,遵循 `02-output-paths.instructions.md` 产物路径规范)
### `.cjs` 文件(自动化脚本)
```js
// *-接口验证.cjs
const http = require('http')
const https = require('https')
const assert = require('assert')
const BASE_URL = process.env.API_BASE_URL
i...
Details
- Author
- devcodex-labs
- Repository
- devcodex-labs/devcodex
- Created
- 5 months ago
- Last Updated
- 2 days ago
- Language
- JavaScript
- License
- AGPL-3.0
Similar Skills
Semantically similar based on skill content — not just same category
Testing & QA Solid
dev-testing
测试规范 — 单元测试/集成测试/API测试/E2E测试四类覆盖标准与触发条件
263 Updated 2 days ago
devcodex-labs Testing & QA Listed
api-qa-skill
API 自动化测试:pytest+Allure 框架,5 阶段完整工作流 + 快速路径(≤5 接口),生成专业测试报告
0 Updated yesterday
kongbai26 API & Backend Listed
devlab-srv-test-api
后端 API 测试专家技能。支持 Java(JUnit)/ Python(pytest)/ Node.js(supertest + jest)后端项目的接口测试、Mock 服务、测试数据管理。
22 Updated 1 weeks ago
seed-forge