api-design

REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting for production APIs. Use when designing or reviewing REST endpoints, resource names, status codes, pagination, or versioning.

Quality

85%

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

Quality

Content

78%Weight 40%Scale 1-5

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

A highly actionable, well-structured REST API reference with strong executable examples across languages. Its main weakness is progressive disclosure: a large single-file body that would benefit from splitting detailed sections into referenced bundle files.

Suggestions

Move the large reference sections (e.g., Pagination, Filtering/Sorting, Versioning, Implementation Patterns) into separate files under references/ and link to them from SKILL.md so the main file stays a concise overview.

Tighten the GOOD/BAD comparison blocks — several repeat the same guidance twice (once as BAD, once as GOOD) and could be consolidated.

Consider adding an explicit validation checkpoint to the implementation workflow (e.g., 'run the checklist before marking an endpoint done') to strengthen workflow_clarity.

Dimension	Reasoning	Score
Conciseness	Largely efficient and reference-dense — it does not belabor concepts Claude already knows — though a few prose lead-ins ('Conventions and best practices for designing consistent, developer-friendly REST APIs') and the duplicated GOOD/BAD blocks could be trimmed.	4 / 5
Actionability	Provides fully executable, copy-paste-ready code in TypeScript/Next.js, Python/DRF, and Go, plus concrete URL patterns, status-code mappings, and SQL snippets covering the common cases.	5 / 5
Workflow Clarity	A 'When to Activate' section and a final 'API Design Checklist' give a clear sequenced set of pre-ship checks, but there is no explicit multi-step workflow with validation checkpoints for risky operations.	4 / 5
Progressive Disclosure	Well-organized with clear section headers, but ~500 lines of API reference (pagination, versioning, implementation patterns) are inlined in SKILL.md with no bundle files or one-level-deep references to split the detail out.	3 / 5
	Total	16 / 20 Passed

Description

92%Weight 40%Scale 1-5

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 strong, specific description that concretely enumerates capabilities and pairs them with a clear 'Use when' trigger clause. Only minor gaps in trigger-term synonyms prevent a perfect trigger_term_quality score.

Dimension	Reasoning	Score
Specificity	Lists multiple specific concrete capabilities — 'resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting' — giving comprehensive coverage of the REST API design domain.	5 / 5
Completeness	Explicitly answers both 'what' (REST API design patterns including the enumerated capabilities) and 'when' ('Use when designing or reviewing REST endpoints...') with concrete trigger phrases.	5 / 5
Trigger Term Quality	Includes natural trigger phrases users would say ('designing or reviewing REST endpoints, resource names, status codes, pagination, or versioning') but omits a few common synonyms such as 'HTTP', 'OpenAPI/Swagger', or 'API contract'.	4 / 5
Distinctiveness Conflict Risk	Occupies a clear niche (REST API production design) with distinct triggers; minimal overlap risk with unrelated skills.	5 / 5
	Total	19 / 20 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 (525 lines); consider splitting into references/ and linking	Warning
metadata_version	'metadata.version' is missing	Warning

	Total	14 / 16 Passed

Repository: affaan-m/ECC
Path: skills/api-design/SKILL.md
Commit: d8409a4

Reviewed: 1 day 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.