api-route-design
Design RESTful FastAPI Routes
Designing REST API routes is hard when validation, status codes, pagination, and response models are inconsistent. This skill gives FastAPI patterns for predictable endpoints, Pydantic schemas, errors, filtering, sorting, and OpenAPI documentation.
Stop for confirmation before installing.
Review the plan and obtain explicit user consent before changing files.
Install with my Agent
Copy this request to your Agent. It includes the canonical Skill page and manifest.
Review the Skillstore skill "api-route-design" from https://skillstore.io/skills/awais68-api-route-design.md and its manifest at https://skillstore.io/api/skills/awais68-api-route-design/manifest. Verify the artifact. Stop and obtain explicit user consent before installing or changing files.Your Agent should still show its plan and request any confirmation required by the security policy.
Agent-readable resources
Use these links when an AI agent, crawler, or script needs clean context instead of reading the full page.
Test it
Using "api-route-design". Design routes for a student fees resource.
Expected outcome:
A route plan with collection and item endpoints, request models, response models, expected status codes, pagination, filters, and error responses.
Using "api-route-design". Review my FastAPI list endpoint for pagination and sorting.
Expected outcome:
A concise review that flags missing limits, unclear sort fields, inconsistent response envelopes, and missing OpenAPI descriptions.
Using "api-route-design". Create an API contract for user notifications.
Expected outcome:
A structured endpoint contract covering route names, methods, validation rules, response shapes, status codes, and authorization notes.
Security Audit
High RiskThe static command-execution and reconnaissance detections are false positives caused by Markdown code formatting and HTTP status documentation. No prompt injection, exfiltration, or executable command behavior was found. One semantic API safety issue remains because a complete endpoint example omits an explicit object-level authorization check.
Confirmed security concerns (1)
Risk Factors
⚙️ External commands (33)
Share & cite this report
Share the versioned assessment report, neutral badge, embed card, and citations. Skillstore reports evidence without deciding whether this Skill is safe.
Copy report link
https://skillstore.io/skills/awais68-api-route-design/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown badge
[](https://skillstore.io/skills/awais68-api-route-design?utm_source=security_passport_badge)HTML badge
<a href="https://skillstore.io/skills/awais68-api-route-design?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/awais68-api-route-design/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Embed card
<iframe src="https://skillstore.io/embed/skills/awais68-api-route-design.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>Academic citations (APA · BibTeX · CFF)
APA citation
Awais68. (2026). api-route-design security audit report (audit version 9) [Author version unspecified]. Skillstore. https://skillstore.io/skills/awais68-api-route-design/audits/9BibTeX citation
@techreport{awais68-awais68-api-route-design-2026,
author = {Awais68},
title = {api-route-design security audit report (audit version 9)},
institution = {Skillstore},
year = {2026},
number = {9},
url = {https://skillstore.io/skills/awais68-api-route-design/audits/9},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "api-route-design security audit report (audit version 9)"
version: "unspecified"
type: report
authors:
- name: "Awais68"
date-released: "2026-07-06"
url: "https://skillstore.io/skills/awais68-api-route-design/audits/9"
identifiers:
- type: other
value: "skillstore:awais68-api-route-design:audit:9"
description: "Skillstore immutable audit report identifier"
Skillstore Score
Why this score Evidence Confidence: MediumWhat You Can Build
Plan a New Resource API
Create consistent list, detail, create, update, patch, and delete routes before implementation begins.
Standardize Existing Endpoints
Align status codes, response models, pagination, filters, and error responses across an existing FastAPI service.
Review API Contracts
Check proposed routes for clear resource naming, validation boundaries, response shapes, and OpenAPI documentation.
Try These Prompts
Use the api-route-design skill to design RESTful FastAPI routes for a resource named orders. Include list, detail, create, update, patch, and delete endpoints.
Use the api-route-design skill to define FastAPI routes for invoices. Include Pydantic request models, path validation, pagination, filtering by status, and sorting rules.
Use the api-route-design skill to review these FastAPI endpoint names and response patterns. Identify inconsistent status codes, weak validation, and missing response models.
Use the api-route-design skill to design a production FastAPI contract for customer payments. Include authorization checks, pagination, filters, errors, status codes, and OpenAPI summaries.
Best Practices
- Start with resource nouns, HTTP method semantics, and status codes before writing handler logic.
- Define Pydantic request and response models for every public endpoint.
- Document authorization, pagination, filters, sorting, and error responses as part of the route contract.
Avoid
- Do not mix singular and plural resource names across related endpoints.
- Do not return raw database objects without an explicit response model.
- Do not copy example authorization patterns without enforcing object-level access rules.
Frequently Asked Questions
What frameworks does this skill target?
Can it design GraphQL APIs?
Does it create database CRUD code?
Does it cover validation?
Does it include pagination and sorting?
Can Claude, Codex, and Claude Code use it?
Developer Details
Author
Awais68License
MIT
Skillstore revision
r1
Version notice
The author did not declare a version.
Ref
c4231f0153ccd2a2ed62274c5a372bf8f2386d3f
Maintenance freshness
7/18/2026
Usage
5 downloads · 207 views