api-design

生产级 API 的 REST API 设计模式，包括资源命名、状态码、分页、过滤、错误响应、版本控制和速率限制。

Quality

80%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./.agents/skills/api-design/SKILL.md

Quality

Content

77%Weight 40%Scale 1-3

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

The skill is highly actionable with executable multi-language examples and a clear pre-publish checklist, but it is a long monolithic reference that could benefit from splitting detail into bundle files and from trimming the redundant multi-language implementations.

Suggestions

Move the detailed reference material (status-code catalog, response-format variants, multi-language implementation examples) into separate files under references/ and keep SKILL.md as a concise overview with one-level-deep links.

Show one canonical implementation in full and summarize the others briefly (e.g. 'Django/Go follow the same validate → 201 + Location pattern'), cutting the redundant multi-language code.

Add a short 'Quick start' section at the top so the core conventions are reachable before the exhaustive reference detail.

Dimension	Reasoning	Score
Conciseness	Mostly efficient with no concept-explanation fluff (it does not explain what REST or a status code is), but the ~510-line body includes three full implementations of the same create-user endpoint in TypeScript, Python, and Go, which could be tightened for context loading. It is not a score-3 'every token earns its place' document because of that redundancy.	2 / 3
Actionability	Provides fully executable, copy-paste-ready code in three languages (Next.js + zod, DRF, Go net/http) plus concrete URL patterns, status-code mappings, and JSON response shapes — matching the 'fully executable code/commands' anchor.	3 / 3
Workflow Clarity	The 'API 设计自检表' checklist is an explicit verification gate before publishing an endpoint, and the versioning section gives a numbered strategy; this is not a destructive/batch operation context, so the checklist satisfies the validation-checkpoint requirement.	3 / 3
Progressive Disclosure	The body is well-organized into clear sections, but it is a ~510-line monolithic document with no bundle files or one-level-deep references — matching the score-2 anchor of '200+ lines of API reference that could be in a separate file'. It is not a score-1 wall of text (navigation is clear), but detailed reference material is inline rather than split out.	2 / 3
	Total	10 / 12 Passed

Description

82%Weight 40%Scale 1-3

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

The description is specific, distinctive, and uses natural trigger terms, but it lacks an explicit 'Use when...' clause telling Claude when to activate the skill. Adding trigger guidance would raise completeness to the top level.

Suggestions

Append a 'Use when...' clause, e.g. 'Use when designing or reviewing REST API endpoints, adding pagination/filtering/error handling, or planning API versioning.'

Include a few colloquial trigger variants users might say (e.g. 'design an API', 'REST endpoints', 'API status codes') to broaden natural-language matching.

Dimension	Reasoning	Score
Specificity	Lists multiple concrete capability areas — "资源命名、状态码、分页、过滤、错误响应、版本控制和速率限制" — rather than vague language, matching the 'lists multiple specific concrete actions' anchor.	3 / 3
Completeness	It clearly states what the skill covers, but there is no 'Use when...' clause or equivalent explicit trigger guidance, so per the rubric guideline completeness is capped at 2 (what is present, when is only implied).	2 / 3
Trigger Term Quality	Natural terms a user would actually say are well covered: "REST API 设计模式", "分页", "过滤", "速率限制", "版本控制", "状态码" — these are the phrases users invoke when requesting API design help.	3 / 3
Distinctiveness Conflict Risk	The REST API design niche is clear and specific, with distinct domain triggers unlikely to fire for unrelated skills; it does not read as a generic catch-all.	3 / 3
	Total	11 / 12 Passed

Validation

87%

Warnings & errors only

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 14 / 16 Passed

Validation for skill structure

Criteria	Description	Result
skill_md_line_count	SKILL.md is long (524 lines); consider splitting into references/ and linking	Warning
frontmatter_unknown_keys	Unknown frontmatter key(s) found; consider removing or moving to metadata	Warning

	Total	14 / 16 Passed

Repository: xu-xiang/everything-claude-code-zh
Path: .agents/skills/api-design/SKILL.md
Commit: dfbf946

Reviewed: 28 days ago

Table of Contents

Discovery Implementation Validation

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.