api-design

api-design is a skill for Claude Code, Codex from zhouguoqing/QianYuan.AIAgenticFramework. It costs 20 tokens per session (163 once invoked), scanned A, original, Apache-2.0.

A guide for designing REST APIs: web interfaces that let software exchange data through standard HTTP requests. It covers the structure and behavior that API users need to rely on.

In plain words
What is it for?
Use it to define resources, URLs, request and response formats, error messages, pagination, filtering, sorting, versioning, access control, and related operational details.
Why use it?
It helps prevent inconsistent endpoints, unclear responses, and breaking changes as an API grows or gains new users.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Use it to define resources, URLs, request and response formats, error messages, pagination, filtering, sorting, versioning, access control, and related operational details.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/zhouguoqing/qianyuan.aiagenticframework/api-design
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.

Any agent
npx skills add zhouguoqing/QianYuan.AIAgenticFramework --skill api-design
Clone the repo
git clone --depth 1 https://github.com/zhouguoqing/QianYuan.AIAgenticFramework

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for api-design

README.md
[![agentmods](https://agentmods.dev/badge/skills/zhouguoqing/qianyuan.aiagenticframework/api-design/github.svg)](https://agentmods.dev/skills/zhouguoqing/qianyuan.aiagenticframework/api-design)
Your own site
<a href="https://agentmods.dev/skills/zhouguoqing/qianyuan.aiagenticframework/api-design"><img src="https://agentmods.dev/badge/skills/zhouguoqing/qianyuan.aiagenticframework/api-design/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for api-design

Your own site · 80×15
<a href="https://agentmods.dev/skills/zhouguoqing/qianyuan.aiagenticframework/api-design"><img src="https://agentmods.dev/badge/skills/zhouguoqing/qianyuan.aiagenticframework/api-design.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 20 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 163 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00020 $0.00163
Opus 5 $0.00010 $0.00081
Sonnet 5 $0.00004 $0.00033
Haiku 4.5 $0.00002 $0.00016

Measured 9d ago against content hash dab2c5f4d93f, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, 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 9d 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.

artifacts/current-working-snapshot-20260803-110837/samples/skills/api-design/SKILL.md · 23 lines

What it actually says

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.

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. 9d ago First seen · 23 lines · 20 tokens per session scan A dab2c5f4d93f

Subscribe to this mod's changes

api-design is a skill published in the GitHub repository zhouguoqing/QianYuan.AIAgenticFramework (36 stars, last pushed 23d ago), licensed Apache-2.0. It adds 20 tokens to every session and 163 once invoked, about $0.0001 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-30.

Related

Other skills, from other repositories

api-designer

Designs production-grade APIs — REST, GraphQL, gRPC, and AsyncAPI patterns including pagination, versioning, error handling, rate limiting, and API governance. Use when the user asks to design APIs, create endpoints, build an API layer, write OpenAPI specs, or needs help with REST/GraphQL/gRPC service design.

buiphucminhtam/forgewright · 73 tokens

api-testing

Comprehensive API testing, validation, and test suite generation.

laragentic/agents · 14 tokens

fastapi

Use when building, reviewing, testing, securing or shipping a FastAPI / async Python service — routers, Pydantic v2 schemas, dependency injection, async SQLAlchemy 2.0, OAuth2/JWT, ASGITransport tests, production wiring. NOT language-level Python or packaging (that is python), NOT engine-level SQL (that is…

ericrisco/rsc-harness · 94 tokens

api-connector-builder

Use when writing a client for someone else's REST or GraphQL API: auth flow choice and token refresh, pagination to exhaustion, retry-with-jitter on transient failures only, rate-limit-aware throttling. NOT inbound callbacks (that is webhooks), NOT chaining services (that is automation-flows), NOT designing your own…

ericrisco/rsc-harness · 80 tokens

api-design

Use when settling the contract of an API you expose, before implementation: resources/URLs, REST vs GraphQL, versioning, one RFC 9457 error envelope, pagination, idempotency — emitted as OpenAPI 3.1. NOT implementing the endpoints (that is fastapi/nestjs/go/nodejs), NOT auth hardening (that is secure-coding), NOT…

ericrisco/rsc-harness · 105 tokens

fastapi-expert

Expert-level FastAPI development for high-performance Python APIs with async support. Use when the user mentions Python, API, async, REST, OpenAPI, or Pydantic, or when the task involves FastAPI Features.

personamanagmentlayer/pcl · 49 tokens