caobingsheng/api-design-principles
api/api-design-principles/SKILL.md
Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.
development
Updated Apr 20, 2026
$ install --global
skillsauthnpx skillsauth add caobingsheng/skills api-design-principlesInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 4, 2026, 11:16 PM17.8s6 files scanned
SKILL.md
- name:
- api-design-principles
- description:
- Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.
- risk:
- safe
- source:
- community
- date_added:
- 2026-02-27
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.mdfor detailed patterns, checklists, and templates.
Related Skills
caobingsheng/tdd-workflows-tdd-refactor
development
VerifiedTrustedCommunity
Use when working with tdd workflows tdd refactor
SKILL.mdUpdated Apr 21, 2026
caobingsheng/tdd-workflows-tdd-red
testing
VerifiedTrustedCommunity
Generate failing tests for the TDD red phase to define expected behavior and edge cases.
SKILL.mdUpdated Apr 21, 2026
caobingsheng/tdd-workflows-tdd-green
development
VerifiedTrustedCommunity
Implement the minimal code needed to make failing tests pass in the TDD green phase.
SKILL.mdUpdated Apr 21, 2026
caobingsheng/tdd-workflows-tdd-cycle
tools
VerifiedTrustedCommunity
Use when working with tdd workflows tdd cycle
SKILL.mdUpdated Apr 21, 2026