Api Design Principles

Skills development 234 Scanned by NVIDIA SkillSpector

Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.

Install Command

npx claude-code-templates@latest --skill development/api-design-principles

View on GitHub

claude-code — api-design-principles

Scanned by NVIDIA SkillSpector

Automated static analysis (no LLM) · v2.12.0 · 2026-10-24

Partial analysis: some checks could not run on this component.

6 observations

scanner score 38/100

SkillSpector looks for patterns such as shell commands, credential access, network calls or unpinned dependencies. An observation is something worth reading in the files before you install, not a confirmed vulnerability. Components that run code locally, like hooks, MCP servers and security tooling, naturally show more of them.

Tool Parameter Abuse
Tool Misuse · references/rest-best-practices.md:79
Tool Parameter Abuse
Tool Misuse · resources/implementation-playbook.md:72
External Transmission ×4
Data Exfiltration · references/rest-best-practices.md:143

Learn more about NVIDIA SkillSpector.

Content

API Design Principles

Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.

Use this skill when

Designing new REST or GraphQL APIs
Refactoring existing APIs for better usability
Establishing API design standards for your team
Reviewing API specifications before implementation
Migrating between API paradigms (REST to GraphQL, etc.)
Creating developer-friendly API documentation
Optimizing APIs for specific use cases (mobile, third-party integrations)

Do not use this skill when

You only need implementation guidance for a specific framework
You are doing infrastructure-only work without API contracts
You cannot change or version public interfaces

Instructions

Define consumers, use cases, and constraints.
Choose API style and model resources or types.
Specify errors, versioning, pagination, and auth strategy.
Validate with examples and review for consistency.

Refer to resources/implementation-playbook.md for detailed patterns, checklists, and templates.

Resources

resources/implementation-playbook.md for detailed patterns, checklists, and templates.