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/en/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
- 4,439 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 design review, contract readiness review, and consumer compatibility audit.
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 Design Quality Review Review API designs, OpenAPI/contracts, request/response examples, error models, authorization, idempotency, pagination, status codes, version evolution, and consumer impact before implementation. It produces `API-##` findings and validation preparation; it does not execute an API or approve a final versioning policy. ## When to Use - Use it to check whether operations, inputs/outputs, errors, permissions, and compatibility evolution are verifiable. - Use it to find contract gaps across consumers, versions, or migration plans. - Use it when examples are incomplete, boundaries are undefined, or runtime evidence is missing. Do not use it to send requests, load-test, execute security tests, or choose a final API versioning policy for a team. ## Output Format Options - Use Markdown by default; when a table, CSV, or JSON is requested, preserve the same evidence, status, impact, owner, and validation fields. - Do not present a structured format or static inventory as execution, pass, approval, or release evidence. ## How to Use 1. Read this Skill's primary prompt and provide the objective, scope, material, environment, and available evidence. …
Read the whole file at its exact version.
How to install
mdr add naodeng/awesome-qa-skills/api-design-quality-review@sha256:9b917435a8c166a5The 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_qmltpzqdikslugpc)
3 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 | 4,439 B | A | view · diff |
| git:20260914.45aa88f | 2026-09-14 | 45aa88f | 4,133 B | A | view · diff |
| git:20260914.ba5cf40 | 2026-09-14 | ba5cf40 | 3,225 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 (4439 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_qmltpzqdikslugpc GET https://markdownregistry.com/api/v1/resolve?ref=naodeng/awesome-qa-skills/api-design-quality-review GET https://markdownregistry.com/api/v1/blob/9b917435a8c166a59857ee7f4ef3e8ec2b477381cf205ce3e99fc18175f24ae2
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