# Api Design

> Design REST API contracts that are consistent, evolvable, and easy to consume.

- **Type:** Skill
- **Install:** `agentstack add skill-zhouguoqing-qianyuan-aiagenticframework-api-design`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [zhouguoqing](https://agentstack.voostack.com/s/zhouguoqing)
- **Installs:** 0
- **Category:** [Agent Skills](https://agentstack.voostack.com/c/agent-skills)
- **Latest version:** 0.1.0
- **License:** Apache-2.0
- **Upstream author:** [zhouguoqing](https://github.com/zhouguoqing)
- **Source:** https://github.com/zhouguoqing/QianYuan.AIAgenticFramework/tree/main/samples/skills/api-design

## Install

```sh
agentstack add skill-zhouguoqing-qianyuan-aiagenticframework-api-design
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## 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](https://github.com/zhouguoqing)
- **Source:** [zhouguoqing/QianYuan.AIAgenticFramework](https://github.com/zhouguoqing/QianYuan.AIAgenticFramework)
- **License:** Apache-2.0

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** no
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-zhouguoqing-qianyuan-aiagenticframework-api-design
- Seller: https://agentstack.voostack.com/s/zhouguoqing
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.