api-design

api-design is a skill for Claude Code from Claude-Code-Community-Ireland/claude-code-resources. It costs 34 tokens per session (3,075 once invoked), scanned A, original, MIT.

Guidance for designing REST APIs, including resource URLs, HTTP methods, status codes, pagination, versioning, and error responses. REST APIs let software exchange data through web requests.

In plain words
What is it for?
Use it when creating or reviewing endpoint names, nested resources, filters, state-changing actions, and API response formats.
Why use it?
It helps APIs remain predictable for the developers and programs that use them.

Skill for Claude Code

Written for Claude Code: shipped in a Claude Code plugin.

Part of the vibeworks-library plugin — 34 skills, 21 commands, 33 agents, 3 hooks shipped together

Good fit Use it when creating or reviewing endpoint names, nested resources, filters, state-changing actions, and API response formats.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/claude-code-community-ireland/claude-code-resources/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 Claude-Code-Community-Ireland/claude-code-resources --skill api-design
Clone the repo
git clone --depth 1 https://github.com/Claude-Code-Community-Ireland/claude-code-resources

Made for: Claude Code.

Or install vibeworks-library, the plugin that ships this one along with the rest of its 34 skills, 21 commands, 33 agents, 3 hooks.

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/claude-code-community-ireland/claude-code-resources/api-design/github.svg)](https://agentmods.dev/skills/claude-code-community-ireland/claude-code-resources/api-design)
Your own site
<a href="https://agentmods.dev/skills/claude-code-community-ireland/claude-code-resources/api-design"><img src="https://agentmods.dev/badge/skills/claude-code-community-ireland/claude-code-resources/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/claude-code-community-ireland/claude-code-resources/api-design"><img src="https://agentmods.dev/badge/skills/claude-code-community-ireland/claude-code-resources/api-design.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 34 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 3,075 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.00034 $0.03075
Opus 5.5 $0.00014 $0.01230
Sonnet 5.5 $0.00007 $0.00615
Haiku 4.5 $0.00003 $0.00308

Measured 1mo ago against content hash 8903ac28adf5, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 1mo 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.

plugins/vibeworks-library/skills/api-design/SKILL.md · 392 lines

How it starts

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

API Design

RESTful Resource Naming

Conventions

Rule Good Bad
Use plural nouns /users /user, /getUsers
Use nouns, not verbs POST /orders POST /createOrder
Nest for relationships /users/123/orders /getUserOrders?userId=123
Use kebab-case /user-profiles /userProfiles, /user_profiles
Keep URLs shallow (max 3) /users/123/orders /users/123/orders/456/items/789
Use query params for filters /orders?status=pending /orders/pending
Collection + resource IDs /users/123 /user?id=123

URL Structure

https://api.example.com/v1/users                    # Collection
https://api.example.com/v1/users/123                # Single resource
https://api.example.com/v1/users/123/orders          # Nested collection
https://api.example.com/v1/users/123/orders/456      # Nested resource
https://api.example.com/v1/orders?status=pending     # Filtered collection

Actions That Do Not Map to CRUD

For operations that are not simple CRUD, use a sub-resource or action noun:

POST /users/123/activate          # State transition
POST /orders/456/refund           # Domain action
POST /reports/export              # Process trigger

HTTP Method Semantics

Method Purpose Idempotent Safe Request Body Success Code
GET Retrieve resource(s) Yes Yes No 200
POST Create a resource No No Yes 201
PUT Full replacement Yes No Yes 200
PATCH Partial update No* No Yes 200
DELETE Remove a resource Yes No No 204

Read the full file on GitHub · 392 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. 1mo ago First seen · 392 lines · 34 tokens per session scan A 8903ac28adf5

Subscribe to this mod's changes

api-design is a skill published in the GitHub repository Claude-Code-Community-Ireland/claude-code-resources (11 stars, last pushed 4mo ago), licensed MIT. It adds 34 tokens to every session and 3,075 once invoked, about $0.0001 per session on Opus 5.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-09-03.

Related

Other skills, from other repositories

mem0-oss-to-platform

Plan, then execute, a migration of a project from the mem0 open-source / self-hosted SDK (local Memory class) to the mem0 Platform / hosted SDK (MemoryClient). TRIGGER when: the developer wants to move, switch, or migrate mem0 off OSS/self-hosted to the hosted API, e.g. "migrate my mem0 setup to the platform", "switch…

mem0ai/mem0 · 217 tokens

agui-dotnet-protobuf

Use the protobuf wire transport (instead of the default Server-Sent Events) for an AG-UI connection with the AG-UI .NET SDK — a compact binary event stream negotiated via the Accept header. USE FOR: making an AGUIChatClient prefer protobuf by wiring an AGUIEventStreamHandler with ProtobufEventStreamFormatter (then…

ag-ui-protocol/ag-ui · 162 tokens

azure-mgmt-botservice-dotnet

Azure Resource Manager SDK for Bot Service in .NET. Management plane operations for creating and managing Azure Bot resources, channels (Teams, DirectLine, Slack), and connection settings. Triggers: "Bot Service", "BotResource", "Azure Bot", "DirectLine channel", "Teams channel", "bot management .NET", "create bot".

microsoft/skills · 78 tokens

fastapi-router-py

Create FastAPI routers with CRUD operations, authentication dependencies, and proper response models. Use when building REST API endpoints, creating new routes, implementing CRUD operations, or adding authenticated endpoints in FastAPI applications.

microsoft/skills · 46 tokens

dev-runtime

How the Node side of a dev stack runs without haven, and the backend host: pnpm dev (UI built once, backend reloading), pnpm dev:hmr (adds the Vite ui lane), tools/dev-runtime (api + worker in one Node process), backend reload on a file change, the debounce (quiet window + max wait), ports derived from PORT. Use when…

langwatch/langwatch · 172 tokens

migrate-segw-to-rap

Reverse-engineer a SEGW-built OData V2 service (MPC/DPC/MPCEXT/DPCEXT) into a modern RAP V4 service — tables, CDS views (interface + projection), behavior definitions, draft entities, service definition + binding. Use when asked to "migrate this SEGW service to RAP", "convert OData V2 to V4 RAP", "modernize this…

arc-mcp/arc-1 · 106 tokens