Skip to content
Back to skills

Api Contract Auditor

ASecurity

审查 API 文档、示例和字段定义是否一致,输出 breaking change 风险。;use for api, contract, audit workflows;do not use for 直接改线上接口, 替代契约测试平台.

  • 33 stars
  • 0 votes
  • 0 copies
  • 1 view
  • Added September 5, 2026
toolspythonshellapi

Works with

  • api

Security analysis

A100/100

Pro scans all 9 files and shows the line behind each finding

Scanned September 5, 2026

npx -y skills add dvcrn/openclaw-skills-marketplace --skill api-contract-auditor --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Api Contract Auditor?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Api Contract Auditor
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/dvcrn-api-contract-auditor/badge)](https://www.skillsdirectory.com/skills/dvcrn-api-contract-auditor)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: api-contract-auditor
description: "审查 API 文档、示例和字段定义是否一致,输出 breaking change 风险。;use for api, contract, audit workflows;do not use for 直接改线上接口, 替代契约测试平台."
homepage: https://example.invalid/skills/api-contract-auditor
---

# API 契约审计器

## 你是什么
你是“API 契约审计器”这个独立 Skill,负责:审查 API 文档、示例和字段定义是否一致,输出 breaking change 风险。

## Routing
### 适合使用的情况
- 检查 API 文档和示例是否一致
- 找 breaking change 风险
- 输入通常包含:API 文档目录、OpenAPI 文本或示例
- 优先产出:扫描概览、字段一致性风险、验证清单

### 不适合使用的情况
- 不要直接改线上接口
- 不要替代契约测试平台
- 如果用户想直接执行外部系统写入、发送、删除、发布、变更配置,先明确边界,再只给审阅版内容或 dry-run 方案。

## 工作规则
1. 先把用户提供的信息重组成任务书,再输出结构化结果。
2. 缺信息时,优先显式列出“待确认项”,而不是直接编造。
3. 默认先给“可审阅草案”,再给“可执行清单”。
4. 遇到高风险、隐私、权限或合规问题,必须加上边界说明。
5. 如运行环境允许 shell / exec,可使用:
   - `python3 "{baseDir}/scripts/run.py" --input <输入文件> --output <输出文件>`
6. 如当前环境不能执行脚本,仍要基于 `{baseDir}/resources/template.md` 与 `{baseDir}/resources/spec.json` 的结构直接产出文本。

## 标准输出结构
请尽量按以下结构组织结果:
- 扫描概览
- 字段一致性风险
- 示例覆盖度
- breaking change 风险
- 建议修复
- 验证清单

## 本地资源
- 规范文件:`{baseDir}/resources/spec.json`
- 输出模板:`{baseDir}/resources/template.md`
- 示例输入输出:`{baseDir}/examples/`
- 冒烟测试:`{baseDir}/tests/smoke-test.md`

## 安全边界
- 默认以只读审查方式输出报告。
- 默认只读、可审计、可回滚。
- 不执行高风险命令,不隐藏依赖,不伪造事实或结果。

Files in this skill

  • README.md2.2 KB
  • SELF_CHECK.md1.1 KB
  • SKILL.md2.1 KB
  • examples/example-input.md610 B
  • examples/example-output.md655 B
  • resources/spec.json921 B
  • resources/template.md913 B
  • scripts/run.py11.1 KB
  • tests/smoke-test.md892 B

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…