Api Design
Design REST API contracts that are consistent, evolvable, and easy to consume.
Install
$ agentstack add skill-zhouguoqing-qianyuan-aiagenticframework-api-design ✓ scanned · ✓ verified — works with Claude Code, Cursor, and more.
Security review
✓ PassedNo issues found. Passed automated security review. · v0.1.0 How review works →
- ✓ Prompt-injection patterns
- ✓ Secret / credential exfiltration
- ✓ Dangerous shell & filesystem operations
- ✓ Untrusted network calls
- ✓ Known-malicious package signatures
What it can access
- ✓ Network access No
- ✓ Filesystem access No
- ✓ Shell / process execution No
- ✓ Environment & secrets No
- ✓ Dynamic code execution No
From automated source analysis of v0.1.0. “Used” means the capability is present in the source — more access means more to trust, not that it’s unsafe.
Verified badge
Passed review? Show it. Paste this badge into your README — it links to the public security report.
Links to your public security report.[](https://agentstack.voostack.com/security/report/skill-zhouguoqing-qianyuan-aiagenticframework-api-design) Reliability & compatibility
Declared compatibility
Compatibility is declared by the source manifest. End-to-end runtime verification is coming — see below.
We're building live execution health for every listing: tool-call success rate, median latency, uptime, and last-checked timestamps — measured, not self-reported. It isn't live yet, so we don't show numbers we can't stand behind.
How agent discovery & health will work →About
API Design
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.
Source & license
This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.
- Author: zhouguoqing
- Source: zhouguoqing/QianYuan.AIAgenticFramework
- License: Apache-2.0
Install and usage instructions live in the source repository linked above.
Reviews
No reviews yet — be the first.
Write a review
Versions
- v0.1.0 Imported from the upstream source.