API Design
SkillMediaDesign REST API contracts that are consistent, evolvable, and easy to consume.
Available today. Use it from your connected AI after setup.
No other account needed.
Add ahel to your AI once: Claude, ChatGPT, Cursor, Claude Code or Codex. Then ask it to use this.
Then ask your AI: use the API Design skill
What this skill tells your AI
The instructions your AI receives, as published by zhouguoqing/qianyuan.aiagenticframework in samples/skills/api-design/SKILL.md and read by ahel’s review.
Use this skill when the user asks to design, review, or refine HTTP API contracts.
Instructions
- Start from resources, use cases, consumers, and versioning needs.
- Prefer stable nouns in paths and HTTP methods with conventional semantics.
- Define request and response shapes, status codes, pagination, filtering, sorting, and error envelopes.
- Make optional fields and future evolution explicit.
- Include idempotency, authentication, authorization, and observability concerns when relevant.
Output Shape
Describe the contract first, then provide examples, then list compatibility and operational notes.
Signals
- GitHub stars
- 37
- Forks
- 1
- Last commit
- Aug 2026
Advanced
- Item type
- skill
- Key
api-design-zhouguoqing- Source
- github.com/zhouguoqing/qianyuan.aiagenticframework