api-design

A planning guide for web APIs, which are agreed ways for programs to request and exchange data. It covers styles such as REST, GraphQL, and tRPC and can produce an OpenAPI description.

In plain words
What is it for?
It helps design endpoints, model resources and their relationships, choose an API style, define request and response schemas, and document authentication, limits, and errors.
Why use it?
It helps settle data formats, routes, access rules, errors, pagination, and versioning before implementation, reducing inconsistent interfaces.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/pixel-process-ug/superkit-agents/api-design
Any agent
npx skills add Pixel-Process-UG/superkit-agents --skill api-design
Clone the repo
git clone --depth 1 https://github.com/Pixel-Process-UG/superkit-agents

Made for: Claude Code, Codex.

Per session 36 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,173 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00036 $0.02173
Opus 5 $0.00018 $0.01086
Sonnet 5 $0.00007 $0.00435
Haiku 4.5 $0.00004 $0.00217

Measured 2d ago against content hash 923019aab071, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

api-design scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

templates/skills/api-design/SKILL.md · 260 lines

How it starts

The opening of the file, as written. The whole thing — 260 lines — stays where its author put it; the contents beside it link to each section on GitHub.

API Design

Overview

Structured API endpoint design through guided discovery. Produces consistent, well-documented API designs with OpenAPI/Swagger specifications. Covers resource modeling, authentication, pagination, error handling, and versioning — ensuring consumer-centric design before any implementation begins.

Announce at start: "I'm using the api-design skill to design the API."

Phase 1: Discovery

Ask these questions ONE AT A TIME:

Resource Questions

# Question What It Determines
1 What entities/resources does this API manage? Resource naming
2 What are the relationships between them? Nested routes, includes
3 What operations are needed for each? (CRUD, search, batch) HTTP methods, endpoints

Consumer Questions

# Question What It Determines
4 Who will consume this API? (frontend, mobile, third-party, internal) Response shape, auth model
5 What authentication/authorization is needed? Security scheme
6 What rate limits or quotas apply? Rate limiting headers

Constraint Questions

# Question What It Determines
7 REST, GraphQL, or tRPC? API paradigm
8 Versioning strategy? (URL path, header, query param) URL structure
9 Pagination approach? (cursor, offset, keyset) List response shape
10 Existing API conventions in the codebase? Consistency constraints

API Paradigm Decision Table

Factor Choose REST Choose GraphQL Choose tRPC
Consumers Multiple, diverse Frontend-heavy, flexible queries TypeScript monorepo
Caching needs Strong (HTTP caching) Moderate (client-side) Low (internal only)
Data shape Predictable, resource-oriented Nested, variable-shape Type-safe RPC
Team familiarity Universal Requires schema knowledge Requires TypeScript
Real-time needs WebSocket addon Subscriptions built-in Subscription support

Read the full file on GitHub · 260 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 260 lines · 36 tokens per session scan A 923019aab071

Subscribe to this mod's changes

api-design is a skill published in the GitHub repository Pixel-Process-UG/superkit-agents (1 stars, last pushed 5mo ago), licensed MIT. It adds 36 tokens to every session and 2,173 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

git-workflow-and-versioning

Structures git workflow practices. Use when making any code change. Use when committing, branching, resolving conflicts, opening or reviewing a pull request (PR), pushing to a remote, or when you need to organize work across multiple parallel streams. Use when cutting a release, choosing a semantic version bump…

addyosmani/agent-skills · 74 tokens

spec-driven-development

Creates specs before coding. Use when starting a new project, feature, or significant change and no specification exists yet. Use when requirements are unclear, ambiguous, or only exist as a vague idea. Use when a single requirement spans several independently testable capabilities and needs decomposing into a…

addyosmani/agent-skills · 67 tokens

idea-refine

Refines raw ideas into sharp, actionable concepts through structured divergent and convergent thinking. Use when an idea is still vague, when you need to stress-test assumptions before committing to a plan, or when you want to expand options before converging on one. Triggers on "ideate", "refine this idea", or…

addyosmani/agent-skills · 75 tokens

chinese-documentation

中文文档排版参考——中英文空格、全半角标点、术语保留、链接格式、中文文案排版指北约定。仅在用户显式 /chinese-documentation 时调用,不要根据上下文自动触发。.

jnMetaCode/superpowers-zh · 62 tokens

chinese-git-workflow

国内 Git 平台配置参考——Gitee、Coding.net、极狐 GitLab、CNB 的 SSH/HTTPS/凭据/CI 接入差异与镜像同步配置。仅在用户显式 /chinese-git-workflow 时调用,不要根据上下文自动触发。.

jnMetaCode/superpowers-zh · 69 tokens

chinese-code-review

中文 review 沟通参考——话术模板、分级标注(必须修复/建议修改/仅供参考)、国内团队常见反模式应对。仅在用户显式 /chinese-code-review 时调用,不要根据上下文自动触发。.

jnMetaCode/superpowers-zh · 62 tokens