Individual skill
api-design
REST/GraphQL/gRPC API design best practices. Use when designing APIs, defining contracts, handling versioning. Covers OpenAPI 3.2, GraphQL Federation, gRPC streaming.
skills/api-design/SKILL.md
Source commit 238e07625aeca5bcf0d6f7cb3e2d07f94c717194
What was checked
- Matches the observed repository HEAD
- Yes
- Scanner rules are current
- Yes
- Repository scan complete
- No
- Skill scan complete
- Yes
- Observed behavior
- Instructions only
- Last checked
- Nov 11, 2026
These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.
Install this skill
Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.
An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.
Repository context
- Repository stars (not skill ratings)
- 290
- Repository last updated
- Nov 4, 2026
- License
- MIT
Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.
- ai-agents Repository topic
- ai-coding-assistant Repository topic
- claude Repository topic
- claude-code Repository topic
- developer-tools Repository topic
- productivity Repository topic
- automation Repository topic
- agent-skills Repository topic
- code-review Repository topic
- prompt-engineering Repository topic
- design Derived category
- docs Derived category
- docs-api Derived category
Files and excerpt
File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.
Browse files
SKILL.mdcore · 8,543 bytesreference/comparison.mddoc · 6,286 bytesreference/graphql.mddoc · 6,371 bytesreference/grpc.mddoc · 7,616 bytesreference/rest.mddoc · 5,467 bytestemplates/graphql/schema.graphqlasset · 4,563 bytestemplates/grpc/service.protoasset · 6,145 bytestemplates/openapi/openapi.yamlasset · 8,549 bytes
Read excerpt
# API Design
## Core Principles
- **Contract-First** — Define API spec before implementation
- **OpenAPI 3.2** — Use OpenAPI for REST API documentation
- **URL Versioning** — Version in path `/v1/`, with Sunset headers
- **Idempotency** — PUT/DELETE must be idempotent, POST uses Idempotency-Key
- **Cursor Pagination** — Avoid offset-based pagination
- **RFC 7807 Errors** — Standard Problem Details format
- **No backwards compatibility** — Delete, don't deprecate
---
## Quick Reference