Content revision r1 Medium Risk๐ Network accessโ๏ธ External commands
Design Better REST and GraphQL APIs
Teams often ship APIs with inconsistent resources, errors, pagination, and versioning. This skill provides REST and GraphQL patterns, review checklists, and templates for durable developer-facing APIs.
Copy this request to your Agent. It includes the canonical Skill page and manifest.
Agent request
Review the Skillstore skill "api-design-principles" from https://skillstore.io/skills/wshobson-api-design-principles.md and its manifest at https://skillstore.io/api/skills/wshobson-api-design-principles/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.
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.
Most static findings are false positives from Markdown examples, GraphQL identifier fields, sample URLs, and HTTP status documentation. One real issue remains: the FastAPI asset presents production guidance while using permissive host, CORS, and bind-address defaults.
The FastAPI asset labels itself production-ready but permits all hosts and CORS origins, then binds to all interfaces when run. Users may copy unsafe defaults into deployed services.
The file directly shows wildcard TrustedHost and CORS settings plus a 0.0.0.0 server binding. TODO comments reduce intent risk, but the production-ready framing makes copy-paste misuse likely.
Capability review items (1)
These are real local capabilities that may be expected for this skill, so they require review but are not counted as confirmed malicious behavior.
The runnable FastAPI template starts Uvicorn on 0.0.0.0, which exposes the service on all interfaces when copied or run. This is a real deployment risk, although it is not malicious exfiltration.
Share the versioned assessment report, neutral badge, embed card, and citations. Skillstore reports evidence without deciding whether this Skill is safe.
Define resource names, methods, status codes, errors, pagination, and versioning before implementation begins.
Set Team API Standards
Create consistent design rules for REST and GraphQL APIs across services and teams.
Review Developer Documentation
Check whether API docs explain auth, errors, examples, pagination, and migration paths clearly.
Try These Prompts
Review A REST API Plan
Review this REST API plan for resource names, HTTP methods, status codes, pagination, and error responses. List the highest priority changes first.
Design A GraphQL Schema
Design a GraphQL schema for this domain. Include types, queries, mutations, pagination choices, error patterns, and DataLoader guidance.
Choose REST Or GraphQL
Evaluate whether this product area should use REST, GraphQL, or both. Consider clients, caching, versioning, performance, and developer experience.
Create API Governance Rules
Create team standards for API naming, versioning, authentication, rate limits, documentation, migrations, and review gates. Include pull request review criteria.
Best Practices
Start with resources, methods, errors, pagination, and auth before writing implementation code.
Review example templates for environment-specific security settings before deployment.
Use DataLoaders or batching for GraphQL fields that traverse relationships.
Avoid
Copying sample server defaults directly into production.
Designing endpoints around verbs instead of resource names.
Adding GraphQL relationships without a batching plan.
Frequently Asked Questions
What API styles does this skill cover?
It covers REST and GraphQL design, including resources, schemas, resolvers, errors, pagination, and versioning.
Can it generate production-ready API code?
It provides examples and templates, but teams must adapt and review them before production use.
Does it replace an API security review?
No. It supports secure design habits, but it does not replace threat modeling or penetration testing.
Can it help with OpenAPI documentation?
Yes. It can guide documentation structure, examples, errors, authentication notes, and review criteria.
Which AI tools can use this skill?
The report lists support for Claude, Codex, and Claude Code.
When should I use this skill?
Use it when designing, reviewing, refactoring, or standardizing REST and GraphQL APIs.