api-design
REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting for production APIs.
Install with Tessl CLI
npx tessl i github:affaan-m/everything-claude-code --skill api-design76
Does it follow best practices?
If you maintain this skill, you can automatically optimize it using the tessl CLI to improve its score:
npx tessl skill review --optimize ./path/to/skillValidation for skill structure
Discovery
60%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 excels at listing specific, concrete capabilities within REST API design, covering seven distinct topics. However, it lacks explicit trigger guidance ('Use when...') which is critical for skill selection, and could benefit from more natural user-facing keywords. The description reads as a topic list rather than actionable selection criteria.
Suggestions
Add a 'Use when...' clause with explicit triggers like 'Use when designing APIs, creating endpoints, or when the user asks about RESTful services, HTTP responses, or API best practices.'
Include common user variations and synonyms: 'RESTful', 'API endpoints', 'HTTP methods', 'CRUD', 'web services', 'API architecture'.
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | Lists multiple specific concrete actions: 'resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting' - these are all distinct, concrete aspects of REST API design. | 3 / 3 |
Completeness | Clearly answers 'what' (REST API design patterns with specific topics), but lacks any explicit 'Use when...' clause or trigger guidance for when Claude should select this skill. | 2 / 3 |
Trigger Term Quality | Contains good technical terms like 'REST API', 'pagination', 'status codes', but missing common user variations like 'RESTful', 'API endpoints', 'HTTP methods', 'CRUD operations', or casual terms users might say. | 2 / 3 |
Distinctiveness Conflict Risk | Focuses on REST API specifically which helps distinguish from general coding skills, but could overlap with broader API skills, backend development skills, or web development skills without explicit boundaries. | 2 / 3 |
Total | 9 / 12 Passed |
Implementation
79%Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
This is a comprehensive, well-structured API design reference with excellent actionability and conciseness. The code examples are production-ready across multiple languages, and the tables efficiently convey decision criteria. The main weaknesses are the monolithic structure (could split implementation patterns into separate files) and lack of explicit validation workflows for the design process itself.
Suggestions
Add explicit validation checkpoints to the design process, such as 'Review against checklist before implementation' and 'Test with sample requests before documenting'
Split implementation patterns (TypeScript, Python, Go examples) into a separate IMPLEMENTATIONS.md file and reference it from the main skill
Consider adding a 'Common mistakes to validate against' section with a feedback loop for catching design errors before shipping
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The content is dense with actionable information and avoids explaining concepts Claude already knows. Tables, code blocks, and bullet points maximize information density without unnecessary prose. | 3 / 3 |
Actionability | Provides fully executable code examples in TypeScript, Python, and Go. URL patterns, status codes, and response formats are concrete and copy-paste ready with specific examples for each pattern. | 3 / 3 |
Workflow Clarity | The checklist at the end provides a clear sequence, but the skill lacks explicit validation checkpoints or feedback loops for the API design process. Steps are listed but there's no 'validate then proceed' pattern for catching design errors early. | 2 / 3 |
Progressive Disclosure | Content is well-organized with clear sections, but it's a monolithic document (~400 lines) that could benefit from splitting implementation patterns and detailed references into separate files. No external file references are provided. | 2 / 3 |
Total | 10 / 12 Passed |
Validation
81%Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.
Validation — 9 / 11 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 | 9 / 11 Passed | |
- Reviewed
Table of Contents
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.