api-design-quality-review SKILL.md skillA
api-design-quality-review from naodeng/awesome-qa-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add naodeng/awesome-qa-skills/api-design-quality-review@v1.0.0Pins v1.0.0 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- naodeng/awesome-qa-skills
- Path
skills/zh/testing-types/api-design-quality-review/SKILL.md- Versions recorded
- 3
- Latest version
- v1.0.0, committed Oct 29, 2026
- First version recorded
- Sep 14, 2026
- Size
- 3,985 bytes
- Repository stars
- 301
- License
- a license file GitHub does not identify
Use this skill when an API, OpenAPI, or consumer contract needs a quality review before implementation or versioning; triggers include API 设计质量评审, API design review, and contract readiness review.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# API 设计质量评审 在实现前评审 API 设计、OpenAPI/契约、请求响应样例、错误模型、鉴权授权、幂等、分页、状态码、版本演进和消费者影响。输出 `API-##` 发现与验证准备，不执行 API，也不批准最终版本策略。 ## 何时使用 - 需要检查 operation、输入输出、错误、权限和兼容演进是否可验证。 - 需要在多个消费者、版本或迁移方案之间发现契约缺口。 - 需要识别样例不完整、未定义边界和缺少运行证据的 API 风险。 不适用于直接发请求、压测、执行安全测试或替团队决定最终 API 版本策略。 ## 输出格式选项 - 默认输出 Markdown；用户要求表格、CSV 或 JSON 时，保留相同的证据、状态、影响、责任角色和验证字段。 - 不把结构化格式或静态清单写成执行、通过、批准或发布证据。 ## 如何使用 1. 先读取本 Skill 的主 Prompt，并提供目标、范围、材料、环境和已有证据。 2. 按 Prompt 的输入审计和输出合同执行；缺少信息时交付带边界的初版。 3. 对每条发现保留来源、证据状态、影响、责任角色、关闭条件和验证方法。 ## 工作方式 1. 阅读 `prompts/api-design-quality-review.md`，审计 API 目标、版本、消费者、范围和证据。 2. 将材料归入 `known`、`missing`、`conflicting`、`stale`、`out_of_scope`、`assumptions`。 3. 按 operation 和稳定字段建立设计覆盖矩阵，使用 `API-##` 绑定来源、证据、影响和验证方法。 4. 分离契约事实、证据推断、建议和 Human 决策；明确兼容性、鉴权和错误处理仍需什么证据。 5. 信息不完整时给出受限初版，不能把请求响应样例当成完整契约。 ## 核心约束 - 不执行 API、调用外部服务或声称安全、兼容、性能测试已通过。 - 不从一个样例补造所有字段、错误、权限、限流、幂等或版本规则。 - 每条 `API-##` 至少包含 operation、来源/证据、影响、兼容风险、责任角色、待决策问题和验证方式。 - 未提供执行身份、时间、环境、输入和原始结果时，运行状态只能是 `unverified`、`unexecuted` 或 `unassessed`。 ## 参考文件 - 每次产出前必须阅读 `prompts/api-design-quality-review.md`。 - 回归时读取 `evals/eval.yaml` 与用例；结构通过不等于 API 行为通过。 …
Read the whole file at its exact version.
How to install
mdr add naodeng/awesome-qa-skills/api-design-quality-review@sha256:8b40ecd68ecb8a4bThe line at the top of this page pins the label v1.0.0, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_rdsj2watxteijw3f)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 3 versions of this file, between Sep 14, 2026 and Oct 29, 2026, about one every 22 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.0.0 latest | 2026-10-29 | 1d0d58f | 3,985 B | A | view · diff |
| git:20260914.45aa88f | 2026-09-14 | 45aa88f | 3,676 B | A | view · diff |
| git:20260914.ba5cf40 | 2026-09-14 | ba5cf40 | 2,887 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (3985 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
naodeng/awesome-qa-skills · 301 stars · license a license file GitHub does not identify · pushed 2026-11-06 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_rdsj2watxteijw3f GET https://markdownregistry.com/api/v1/resolve?ref=naodeng/awesome-qa-skills/api-design-quality-review GET https://markdownregistry.com/api/v1/blob/8b40ecd68ecb8a4bcd14c705314eef0cef0d9d07ea3f349d3f3a6dc76cb1c931
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from naodeng/awesome-qa-skills
Every file in naodeng/awesome-qa-skills