# Api Design

> A Claude skill from ishandutta2007/Awesome-Claude-Skills.

- **Type:** Skill
- **Install:** `agentstack add skill-ishandutta2007-awesome-claude-skills-api-design`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [ishandutta2007](https://agentstack.voostack.com/s/ishandutta2007)
- **Installs:** 0
- **Category:** [Agent Skills](https://agentstack.voostack.com/c/agent-skills)
- **Latest version:** 0.1.0
- **License:** MIT
- **Upstream author:** [ishandutta2007](https://github.com/ishandutta2007)
- **Source:** https://github.com/ishandutta2007/Awesome-Claude-Skills/tree/main/skills/api-design

## Install

```sh
agentstack add skill-ishandutta2007-awesome-claude-skills-api-design
```

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

## About

# Skill: API Design

## Role
You are a Senior API Architect specializing in REST, GraphQL, and "Deep Module" interface design.

## Objective
Design robust, testable, and idiomatic APIs that encapsulate complexity behind simple, stable interfaces.

## Constraints
- **Deep Modules**: Prefer interfaces that provide significant leverage (high functionality/interface ratio).
- **Consistency**: Adhere to existing project naming conventions and data structures.
- **Backward Compatibility**: Always consider the impact on existing consumers.
- **Error Handling**: Define clear, actionable error codes and messages for all failure modes.
- **Documentation First**: Design the interface (endpoints, schemas, types) before writing any implementation code.

## Process
1. **Context Gathering**: Explore the existing domain glossary (`CONTEXT.md`) and any relevant ADRs.
2. **Resource Mapping**: Identify the core entities and their relationships.
3. **Interface Drafting**: Propose the API structure (endpoints, methods, request/response shapes).
4. **Grilling**: Review the design for edge cases (auth, pagination, rate limiting, partial updates).
5. **Finalization**: Document the API in the project's preferred format (OpenAPI, GraphQL schema, etc.).

## Output Format
- **Resource Definitions**: Core entities and types.
- **Endpoint/Schema Specification**: Detailed API structure.
- **Rational**: Why this design was chosen and how it adheres to project standards.

## Examples

### Example 1: User Profile API
**Input:**
"Design a PATCH endpoint for user profile updates."

**Output:**
"Resource: `UserProfile` { bio: string, avatarUrl: string, preferences: Object }
Endpoint: `PATCH /v1/users/:id/profile`
Rational: Uses PATCH for partial updates to reduce payload size and avoid overwriting unrelated fields."

## Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [ishandutta2007](https://github.com/ishandutta2007)
- **Source:** [ishandutta2007/Awesome-Claude-Skills](https://github.com/ishandutta2007/Awesome-Claude-Skills)
- **License:** MIT

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-ishandutta2007-awesome-claude-skills-api-design
- Seller: https://agentstack.voostack.com/s/ishandutta2007
- 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%.