route-to-openapi

Generates RESTful API documentation (OpenAPI 3.0 / Swagger spec) by scanning route definitions in code for Flask, FastAPI, Express, Gin, and other frameworks. Trigger when users ask about API documentation, OpenAPI, Swagger, endpoint docs, generating docs from code, or extracting endpoints.

Quality

91%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Passed

No findings from the security scan

Quality

Content

88%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 well-structured, actionable skill body with copy-paste-ready commands, complete parameter documentation, and a real referenced script. Minor trimming of the introductory paragraphs and extraction bullet list would improve token efficiency, and the inline framework/extraction tables could arguably be split out, but the organization is solid.

Suggestions

Trim the two introductory paragraphs under the title — the description frontmatter and the Supported Frameworks table already convey the same information.

Consider collapsing the Extraction Capabilities bullet list or merging it into the Output Example, since the example already demonstrates most of those capabilities concretely.

If the framework support or path-conversion tables grow, move them into a references/ file and link from the body to keep the overview lean.

Dimension	Reasoning	Score
Conciseness	Efficient and mostly lean — organized as tables and executable examples with no padding of concepts Claude already knows — but the two introductory paragraphs and the Extraction Capabilities bullet list slightly restate information already conveyed by the tables.	4 / 5
Actionability	Fully executable, copy-paste-ready Quick Start commands covering the common cases (format, output path, framework, title, servers), a complete Parameters table, and a concrete JSON output example; the referenced script is a real bundle file.	5 / 5
Workflow Clarity	A simple single-action skill (run the generator script) whose single action is unambiguous and fully specified by the Quick Start commands and parameter table; the operation is non-destructive so no validation checkpoint is required.	5 / 5
Progressive Disclosure	Well-organized into clearly labeled sections with a single real bundle reference (scripts/generate_api_doc.py) and no nested reference chains; the framework and extraction tables are somewhat lengthy inline content but appropriately placed for an overview.	4 / 5
	Total	18 / 20 Passed

Description

95%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, well-constructed description that clearly states what the skill does and when to invoke it, with comprehensive natural trigger terms and a distinct niche. The only minor gap is that the capability set boils down to one core action rather than multiple distinct ones.

Dimension	Reasoning	Score
Specificity	Names the domain and concrete actions ('Generates RESTful API documentation', 'scanning route definitions in code') plus a comprehensive list of supported frameworks, but the action set is essentially one core capability rather than multiple distinct concrete actions.	4 / 5
Completeness	Explicitly answers both 'what' (generates OpenAPI/Swagger specs by scanning route definitions) and 'when' ('Trigger when users ask about...') with concrete trigger phrases.	5 / 5
Trigger Term Quality	Comprehensive natural trigger terms including synonyms and variations — 'API documentation, OpenAPI, Swagger, endpoint docs, generating docs from code, or extracting endpoints' — which users would naturally say.	5 / 5
Distinctiveness Conflict Risk	Clear niche — generating OpenAPI/Swagger specs from source-code route definitions across named frameworks — with distinct triggers and minimal overlap with other skills.	5 / 5
	Total	19 / 20 Passed

Validation

100%

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 — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository: zebbern/claude-code-guide
Path: skills/route-to-openapi/SKILL.md
Commit: 9d252b3

Reviewed: 2 days 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.