fastapi-best-practices

FastAPI best practices and conventions. Use when writing, reviewing, or refactoring FastAPI applications — route handlers, Pydantic schemas, dependency injection, project structure, async patterns, testing, or API documentation. Triggers on tasks involving FastAPI routers, endpoints, request validation, response models, or application configuration. Does not cover general Python syntax or typing — see modern-python-development for that.

Quality

90%

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

80%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-architected overview skill: lean, well-structured, with a clear category-to-reference map pointing to verified one-level-deep reference files. It loses a little on actionability (code lives in references, not the body) and on workflow_clarity (no multi-step process to sequence, which is appropriate for a conventions skill but still caps the dimension).

Suggestions

Add one short copy-paste-ready code snippet in the body (e.g. a minimal async route + dependency example) so the overview is actionable without opening a reference file.

For the Testing section, include the single httpx + ASGITransport fixture inline rather than only linking out — it is the one snippet users need 'from day one'.

Dimension	Reasoning	Score
Conciseness	The body is a lean overview: short bulleted rules and a single directory tree, with no padding or restating of basic concepts Claude already knows; every section is terse and points to a reference for depth.	5 / 5
Actionability	Most guidance is concrete and executable (a full directory tree, exact naming rules like 'lower_case_snake, singular (post, user, post_like)', and config flags like 'openapi_url=None'), but the body itself carries little runnable code — the executable examples live in the reference files, so minor gaps remain inline.	4 / 5
Workflow Clarity	This is a reference/convention skill rather than a destructive batch workflow, so no multi-step process or validation checkpoints are needed; the body offers categorized guidance but no sequenced workflow, which caps it at the midpoint.	3 / 5
Progressive Disclosure	Excellent one-level-deep structure: a Categories table maps each topic to a real reference file (all four references verified to exist — async-patterns.md, dependencies.md, pydantic-patterns.md, project-conventions.md), each section ends with 'See references/... for ...', and the 'How to Use' note explains the split; navigation is easy and nothing is nested beyond one level.	5 / 5
	Total	17 / 20 Passed

Description

100%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 is exemplary: concrete capabilities, natural trigger terms, explicit 'what' and 'when' clauses, and explicit boundary guidance against a sibling Python skill. It lands at the top anchor on every dimension.

Dimension	Reasoning	Score
Specificity	Enumerates multiple concrete capability areas — 'route handlers, Pydantic schemas, dependency injection, project structure, async patterns, testing, or API documentation' plus 'routers, endpoints, request validation, response models, or application configuration' — giving comprehensive concrete coverage rather than vague phrasing.	5 / 5
Completeness	Explicitly answers both what ('FastAPI best practices and conventions') and when ('Use when writing, reviewing, or refactoring FastAPI applications', 'Triggers on tasks involving...'), satisfying the top anchor with concrete trigger phrases.	5 / 5
Trigger Term Quality	Natural user-facing phrases like 'writing, reviewing, or refactoring FastAPI applications', 'FastAPI routers, endpoints', 'request validation', and 'response models' align closely with what a user would say; full coverage of the domain's vocabulary.	5 / 5
Distinctiveness Conflict Risk	A clear FastAPI niche with explicit boundary guidance ('Does not cover general Python syntax or typing — see modern-python-development for that') sharply separates it from sibling skills, minimizing conflict risk.	5 / 5
	Total	20 / 20 Passed

Validation

93%

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

Validation for skill structure

Criteria	Description	Result
frontmatter_unknown_keys	Unknown frontmatter key(s) found; consider removing or moving to metadata	Warning

	Total	15 / 16 Passed

Repository: provectus/awos-recruitment
Path: registry/skills/fastapi-best-practices/SKILL.md
Commit: 298fce7

Reviewed: 4 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.