api-design

api-design is a skill for Claude Code, Codex 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 CodeCodex

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

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/komluk/scaffolding/api-design
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, Codex.

Or install scaffolding, the plugin that ships this one along with the rest of its 35 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.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.svg" alt="Measured on agentmods" 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. 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.00068 $0.01280
Opus 5 $0.00034 $0.00640
Sonnet 5 $0.00014 $0.00256
Haiku 4.5 $0.00007 $0.00128

Measured 3d ago against content hash 4c23c8cc6ccd, 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 3d 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. 3d 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 28d ago), licensed MIT. It adds 68 tokens to every session and 1,280 once invoked, about $0.0003 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

ideogram-ultra

Build Ideogram 4 (Ideogram Ultra) txt2img and img2img workflows with the local open-weights model, dual conditional/unconditional models with DualModelGuider, Qwen3-VL text encoder, and structured JSON ("compositional deconstruction") prompts for strong text rendering and layout control.

artokun/comfyui-mcp · 68 tokens

civitai

Discover Civitai models with the BUILT-IN downloadmodel action:"searchcivitai" and install/generate them locally. Find a checkpoint/LoRA/embedding on Civitai, download it into ComfyUI, and use its trigger words. Optionally pair the official Civitai MCP for community features (images browsing, posting, collections).

artokun/comfyui-mcp · 76 tokens

brand-setup

Create or update the brand profile every other skill reads — a quick 5-question or full 17-question interactive setup capturing identity, business model, industry and compliance markets, 4-dimension voice scales, channels, goals, and competitors, saved to /.claude-marketing/brands/{slug}/profile.json via…

indranilbanerjee/digital-marketing-pro · 148 tokens

spring-security-jwt

Use when an application issues and validates its own first-party JWT access and refresh tokens, including authentication filters, password encoding, RBAC, and method security. For JWTs issued by Keycloak, Auth0, Okta, Cognito, or another authorization server, use oauth2-resource-server.

rrezartprebreza/spring-boot-skills · 64 tokens

spring-ai-integration

Use when integrating LLMs, chat clients, embeddings, RAG pipelines, or AI agents into Spring Boot. Covers Spring AI ChatClient, prompt templates, embeddings, vector stores, and structured output. Use when user mentions Spring AI, LLM, ChatGPT, Claude, RAG, embeddings.

rrezartprebreza/spring-boot-skills · 66 tokens

mcp-server

Use when exposing Spring Boot 3 application capabilities through Model Context Protocol tools, resources, or prompts. Covers Spring AI 1.x tool callback registration, transports, schemas, errors, security, and standalone MCP Java SDK compatibility.

rrezartprebreza/spring-boot-skills · 49 tokens