CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

rest-api-design-patterns

Comprehensive guide for designing RESTful APIs including resource modeling, versioning strategies, HATEOAS, pagination, filtering, and HTTP best practices

Quality

68%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./plugins/luxor-backend-toolkit/skills/rest-api-design-patterns/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

57%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.

The content is highly actionable with comprehensive executable examples, but it is severely over-long, duplicates implementations across two frameworks, explains concepts Claude already knows, and inlines everything instead of splitting into reference files.

Suggestions

Collapse the per-method FastAPI/Express duplication: show one canonical framework per pattern and link to a separate per-framework reference for the alternates.

Cut concept explanations Claude already knows (REST definition, HTTP method semantics, what HATEOAS/JWT are) and keep only the opinionated patterns.

Move the bulk of the versioning, pagination, filtering, security, and performance sections into references/ files, leaving SKILL.md as a concise overview with one-level-deep links.

DimensionReasoningScore

Conciseness

At ~1800 lines the body duplicates nearly every pattern across both FastAPI and Express.js with repeated try/catch boilerplate, and explains concepts Claude already knows (REST definition, what each HTTP method means, HATEOAS, JWT), making it noticeably verbose with many padded sections.

2 / 5

Actionability

Provides fully executable, copy-paste-ready code in both frameworks covering CRUD, pagination, filtering, versioning, auth, caching, and error handling with imports, status codes, and headers — comprehensive coverage of common cases.

5 / 5

Workflow Clarity

This is a patterns catalog rather than a sequenced procedure; the 'When to Use' list enumerates use cases and sections are organized, but there is no explicit multi-step workflow with validation checkpoints or feedback loops.

3 / 5

Progressive Disclosure

No bundle files exist and all ~1800 lines are inlined in SKILL.md with zero external references; section headers provide real structure, but reference-grade material (per-framework code, deep dives on versioning/pagination/security) that belongs in separate files is fully inline.

3 / 5

Total

13

/

20

Passed

Description

66%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.

The description clearly scopes a REST API design niche with good keyword coverage and concrete sub-topics, but it omits any explicit 'when to use' trigger clause, which caps completeness and slightly weakens its routing utility.

Suggestions

Add an explicit trigger clause, e.g. 'Use when designing or refactoring REST APIs, modeling resources, or choosing versioning/pagination strategies'.

Reframe the topic list as concrete actions ('Model resources, version APIs, add HATEOAS links, paginate and filter collections') to lift specificity from 4 toward 5.

Include a couple of natural user phrasings or synonyms ('build an API', 'REST endpoints') to broaden trigger-term coverage.

DimensionReasoningScore

Specificity

Names the domain ('designing RESTful APIs') and lists several concrete sub-areas ('resource modeling, versioning strategies, HATEOAS, pagination, filtering, and HTTP best practices'), but frames them as topics rather than concrete verb actions, so it falls below the anchor-5 'multiple specific concrete actions'.

4 / 5

Completeness

Has a clear 'what' but no 'Use when...' trigger clause in the description field; per the rubric guideline a missing explicit trigger clause caps completeness at 3.

3 / 5

Trigger Term Quality

Includes natural terms a user would say ('RESTful APIs', 'HATEOAS', 'pagination', 'versioning', 'HTTP best practices') with good coverage, but misses common variations like 'build an API', 'REST endpoints', or 'API routes'.

4 / 5

Distinctiveness Conflict Risk

'RESTful API design' with HATEOAS/pagination/versioning is a recognizable niche with distinct triggers, with only minor overlap risk against general backend or web-framework skills.

4 / 5

Total

15

/

20

Passed

Validation

87%

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

CriteriaDescriptionResult

skill_md_line_count

SKILL.md is long (1822 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

manutej/luxor-claude-marketplace

Path

plugins/luxor-backend-toolkit/skills/rest-api-design-patterns/SKILL.md

Revision

1861cc9

Reviewed

Table of Contents

DiscoveryImplementationValidation

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.

Claim skill