api-design

api-design is a skill for Claude Code from komluk/scaffolding. It costs 68 tokens per session (1,280 once invoked), scanned A, original, MIT.

A set of rules for designing REST APIs, which are web interfaces that let programs read and change resources through standard HTTP requests. It covers URL names, request methods, status codes, pagination, versions, and error responses.

In plain words
What is it for?
Use it when defining endpoints, documenting an API, adding pagination or filters, designing error responses, or planning API versioning.
Why use it?
It gives an API a consistent structure so clients can understand how to access data and interpret failures. It also helps avoid unclear endpoint and response designs.

Skill for Claude Code

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

Part of the scaffolding plugin — 39 skills, 9 commands, 13 agents shipped together

Good fit Use it when defining endpoints, documenting an API, adding pagination or filters, designing error responses, or planning API versioning.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/komluk/scaffolding/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 komluk/scaffolding --skill api-design
Clone the repo
git clone --depth 1 https://github.com/komluk/scaffolding

Made for: Claude Code.

Or install scaffolding, the plugin that ships this one along with the rest of its 39 skills, 9 commands, 13 agents.

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/komluk/scaffolding/api-design/github.svg)](https://agentmods.dev/skills/komluk/scaffolding/api-design)
Your own site
<a href="https://agentmods.dev/skills/komluk/scaffolding/api-design"><img src="https://agentmods.dev/badge/skills/komluk/scaffolding/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/komluk/scaffolding/api-design"><img src="https://agentmods.dev/badge/skills/komluk/scaffolding/api-design.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 68 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,280 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.00068 $0.01280
Opus 5.5 $0.00027 $0.00512
Sonnet 5.5 $0.00014 $0.00256
Haiku 4.5 $0.00007 $0.00128

Measured 1mo ago against content hash 4c23c8cc6ccd, 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.

skills/api-design/SKILL.md · 208 lines

How it starts

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

API Design Skill

Purpose

Standards and best practices for designing RESTful APIs.

Auto-Invoke Triggers

  • Designing new API endpoints
  • Creating OpenAPI documentation
  • Implementing API versioning
  • Designing error responses
  • Implementing pagination

REST API Principles

Resource Naming

  • Use nouns, not verbs: /users not /getUsers
  • Use plural nouns: /users not /user
  • Use kebab-case: /user-profiles not /userProfiles
  • Use lowercase only
  • Max 2 levels nesting: /users/{id}/posts

URL Patterns

Pattern Example Use Case
Collection /users List resources
Item /users/{id} Single resource
Nested /users/{id}/posts Related resources
Action /users/{id}/activate Non-CRUD operations

HTTP Methods

Method Purpose Idempotent Safe Has Body
GET Read Yes Yes No
POST Create No No Yes
PUT Replace entire resource Yes No Yes
PATCH Partial update No No Yes
DELETE Remove Yes No No

Method Selection Rules

  • GET for retrieval only, never modify state
  • POST for creation, returns 201 with Location header
  • PUT replaces entire resource, all fields required
  • PATCH for partial updates, only changed fields
  • DELETE returns 204 No Content on success

Status Codes

Success (2xx)

Code Use Case
200 OK GET, PUT, PATCH success
201 Created POST success (+ Location header)
204 No Content DELETE success

Client Error (4xx)

Code Use Case
400 Bad Request Malformed request, validation error
401 Unauthorized Authentication required
403 Forbidden Authenticated but no permission
404 Not Found Resource doesn't exist
409 Conflict Resource state conflict
422 Unprocessable Entity Semantic validation error
429 Too Many Requests Rate limit exceeded

Read the full file on GitHub · 208 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 · 208 lines · 68 tokens per session scan A 4c23c8cc6ccd

Subscribe to this mod's changes

api-design is a skill published in the GitHub repository komluk/scaffolding (15 stars, last pushed 2d ago), licensed MIT. It adds 68 tokens to every session and 1,280 once invoked, about $0.0003 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-08-30.

Related

Other skills, from other repositories

data-engineering

Builds and operates data pipelines — ingestion, transformation, orchestration, quality testing, and reliability of data delivery. Use this to design or debug a pipeline, decide batch versus streaming, add data quality checks, handle late or duplicate data, or work out why a dashboard's numbers changed without anyone…

cbrock84/headcount · 67 tokens

api-design

Designs interfaces that survive their consumers — resource modeling, errors, versioning, pagination, and compatibility. Use this to design a new API, review one before it ships, decide how to version or deprecate, fix an interface consumers keep misusing, or work out whether a change is breaking.

cbrock84/headcount · 64 tokens

architecture-selection

System architecture patterns including monolith, microservices, event-driven, and serverless, with C4 modeling, scalability strategies, and technology selection criteria. Use when designing system architectures, evaluating patterns, or planning scalability.

rsmdt/the-startup · 46 tokens

api-contract-design

REST and GraphQL API design patterns, OpenAPI/Swagger specifications, versioning strategies, and authentication patterns. Use when designing APIs, reviewing API contracts, evaluating API technologies, or implementing API endpoints.

rsmdt/the-startup · 44 tokens

domain-modeling

Unified domain and data modeling for business entities, invariants, schema design, aggregate boundaries, and evolution strategy. Use when designing business models, schema changes, bounded contexts, or consistency rules.

rsmdt/the-startup · 42 tokens

api-design

This skill should be used when the user needs to "design the API", do "endpoint design", pin down a "request/response shape", choose a "pagination" strategy (cursor vs offset), add an "idempotency key" to a write, plan "API versioning", an "error contract", or pick between "REST vs gRPC vs GraphQL" or "WebSocket vs…

proyecto26/system-design-skills · 129 tokens