generating-rest-apis
Generate complete REST API implementations from OpenAPI specifications or database schemas. Use when generating RESTful API implementations. Trigger with phrases like "generate REST API", "create RESTful API", or "build REST endpoints".
47
51%
Does it follow best practices?
Impact
—
No eval scenarios have been run
Passed
No known issues
Optimize this skill with Tessl
npx tessl skill review --optimize ./plugins/api-development/rest-api-generator/skills/generating-rest-apis/SKILL.mdQuality
Discovery
67%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 functional and includes explicit trigger guidance with a 'Use when' clause and example phrases, which is good for completeness. However, it lacks specificity about what the generated output includes (routes, controllers, models, validation, etc.) and could benefit from broader trigger term coverage including common synonyms like 'swagger', 'CRUD', or 'API scaffold'.
Suggestions
Add specific concrete actions describing what the implementation includes, e.g., 'Generates controllers, routes, models, validation, and error handling from OpenAPI specifications or database schemas'.
Expand trigger terms to include common variations users would naturally say, such as 'swagger', 'CRUD endpoints', 'API scaffold', 'API boilerplate', or 'web service endpoints'.
| Dimension | Reasoning | Score |
|---|---|---|
Specificity | It names the domain (REST API implementations) and mentions inputs (OpenAPI specifications, database schemas), but doesn't list specific concrete actions beyond 'generate'. It lacks detail on what the implementation includes (e.g., controllers, routes, middleware, validation, error handling). | 2 / 3 |
Completeness | Clearly answers both 'what' (generate REST API implementations from OpenAPI specs or database schemas) and 'when' (explicit 'Use when' clause and 'Trigger with phrases' providing concrete trigger guidance). | 3 / 3 |
Trigger Term Quality | Includes relevant terms like 'REST API', 'RESTful API', 'REST endpoints', 'OpenAPI specifications', and 'database schemas'. However, it misses common variations users might say such as 'API scaffold', 'CRUD endpoints', 'swagger', 'API boilerplate', or 'web service'. | 2 / 3 |
Distinctiveness Conflict Risk | The focus on REST API generation from OpenAPI specs/database schemas is fairly specific, but 'generate REST API' could overlap with general code generation skills or broader API-related skills. The description doesn't strongly differentiate from a generic code generation skill. | 2 / 3 |
Total | 9 / 12 Passed |
Implementation
35%Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
This skill provides a broad architectural overview of REST API generation but lacks the concrete, executable guidance needed to be truly actionable. It covers many frameworks and scenarios without providing specific code for any of them, resulting in a skill that reads more like a feature specification than an implementation guide. The referenced bundle files (implementation.md, errors.md, examples.md) don't exist, undermining the progressive disclosure structure.
Suggestions
Add concrete, executable code examples for at least one framework (e.g., a complete Express route file or FastAPI endpoint) showing the expected generated output for a sample resource.
Include validation checkpoints in the workflow, such as 'Run the generated tests to verify all endpoints return expected status codes' and 'Validate openapi.yaml against the OAS 3.0 schema using a linter'.
Provide the referenced bundle files (implementation.md, errors.md, examples.md) or remove the references and inline the essential content.
Replace the prose-only examples with concrete input/output pairs showing a sample OpenAPI spec snippet and the corresponding generated code.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The skill is moderately verbose. The prerequisites section lists many alternatives (4 frameworks, 3 databases, multiple package managers) without clear guidance on which to use. The overview restates what the instructions cover. However, it avoids explaining basic concepts Claude already knows and stays relatively focused. | 2 / 3 |
Actionability | Despite covering a complex topic, the skill provides zero executable code examples. All instructions are high-level descriptions ('Create route files implementing...', 'Implement controller logic with...') without any concrete code snippets, command-line invocations, or copy-paste ready templates. The examples section describes scenarios in prose rather than showing actual input/output. | 1 / 3 |
Workflow Clarity | The 9 steps provide a reasonable sequence for API generation, but there are no validation checkpoints or feedback loops. There's no step to verify generated code compiles/runs, no instruction to validate the OpenAPI spec matches the implementation, and no error recovery guidance within the workflow itself. For a code generation task that could produce broken output, this is a significant gap. | 2 / 3 |
Progressive Disclosure | The skill references three external files (implementation.md, errors.md, examples.md) which is good structure, but no bundle files are provided, meaning these references are broken. The main file itself is reasonably organized with clear sections, but the error handling table and examples could have been more concise in the main file since they're supposedly covered in referenced files. | 2 / 3 |
Total | 7 / 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 |
|---|---|---|
allowed_tools_field | 'allowed-tools' contains unusual tool name(s) | Warning |
frontmatter_unknown_keys | Unknown frontmatter key(s) found; consider removing or moving to metadata | Warning |
Total | 9 / 11 Passed | |
- Commit
16dfbca
- 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.