api-design

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

Quality

73%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

High

Do not use without reviewing

Fix and improve this skill with Tessl

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

Quality

Content

65%

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

A thorough, highly actionable REST API design reference with executable multi-language examples and a useful checklist. It is weakened by conciseness (restating well-known HTTP/REST concepts) and by being a monolithic inline document with no progressive disclosure or sequenced validation workflow.

Suggestions

Move the per-language implementation patterns and the full pagination/filtering reference into separate reference files (e.g. IMPLEMENTATION.md, PAGINATION.md) and link to them from a concise overview in SKILL.md to improve progressive disclosure.

Trim or condense standard knowledge Claude already has (the status-code reference table, basic REST naming rules) so the body adds only non-obvious guidance and earns its token budget.

Frame the design guidance as a short sequenced workflow with explicit validation checkpoints (e.g. design -> validate input schema -> verify status codes/auth -> run checklist) rather than only a flat catalog plus a post-hoc checklist.

Dimension	Reasoning	Score
Conciseness	The body is well-organized as a reference catalog but largely restates standard knowledge Claude already has (HTTP status-code meanings, REST plural-kebab-case naming, offset vs cursor pagination), so it is mostly efficient yet includes content that could be trimmed or tightened.	2 / 3
Actionability	It provides fully executable, copy-paste-ready examples in TypeScript (Next.js + Zod), Python (Django REST Framework), and Go (net/http), plus concrete SQL and JSON response shapes, matching the score-3 anchor.	3 / 3
Workflow Clarity	The content is a reference catalog rather than a sequenced multi-step process; although a pre-publish checklist and a numbered versioning strategy exist, there are no explicit validation checkpoints or validate-fix-retry feedback loops for a defined workflow.	2 / 3
Progressive Disclosure	No bundle files exist and the entire ~500-line reference lives inline in SKILL.md; it is cleanly sectioned (avoiding a true wall of text) but content that could be split out (per-language implementation patterns, full pagination/filtering reference) is inline with no one-level-deep references.	2 / 3
	Total	9 / 12 Passed

Description

82%

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

A specific, well-scoped description that names concrete capability areas and natural trigger terms within a distinct REST-API-design niche. Its only meaningful gap is the absence of an explicit 'Use when...' trigger clause, which caps completeness at 2.

Suggestions

Append an explicit trigger clause, e.g. 'Use when designing or reviewing REST APIs, adding pagination/filtering/error handling, or planning API versioning.' to raise completeness to 3.

Include a few common user phrasings ('API design', 'API endpoints', 'API best practices') to broaden trigger-term variations.

Dimension	Reasoning	Score
Specificity	The description enumerates seven concrete capability areas — '资源命名、状态码、分页、过滤、错误响应、版本控制和速率限制' — matching the score-3 anchor of listing multiple specific concrete items rather than vague abstraction.	3 / 3
Completeness	It clearly states what the skill covers (REST API design patterns and the listed sub-areas) but contains no explicit 'Use when...' clause or equivalent trigger guidance, so per the judging guideline completeness is capped at 2.	2 / 3
Trigger Term Quality	Terms such as 'REST API', 'API', '分页' (pagination), '速率限制' (rate limiting), and '版本控制' (versioning) are exactly the natural keywords a user would say when requesting API design help, giving good coverage rather than jargon-only phrasing.	3 / 3
Distinctiveness Conflict Risk	'生产级 API 的 REST API 设计模式' carves out a clear, narrow niche (REST API design) with distinct triggers, making it unlikely to fire for unrelated skills.	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: about 2 hours 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.