principle-api-design

principle-api-design is a skill for Claude Code from lugassawan/swe-workbench. It costs 69 tokens per session (1,218 once invoked), scanned A, original, MIT.

Guidance for designing APIs as clear contracts between software systems. It covers how interfaces evolve, how requests can be safely retried, and how data is shaped and delivered.

In plain words
What is it for?
Use it when designing REST, RPC, or event-based APIs, choosing versions, adding pagination, defining errors, or handling retries.
Why use it?
It helps prevent changes that unexpectedly break existing users and makes API behavior clearer before implementation begins.

Skill for Claude Code

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

Part of the swe-workbench plugin — 60 skills, 25 commands, 22 agents, 4 hooks shipped together

Good fit Use it when designing REST, RPC, or event-based APIs, choosing versions, adding pagination, defining errors, or handling retries.

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

Made for: Claude Code.

Or install swe-workbench, the plugin that ships this one along with the rest of its 60 skills, 25 commands, 22 agents, 4 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 principle-api-design

README.md
[![agentmods](https://agentmods.dev/badge/skills/lugassawan/swe-workbench/principle-api-design/github.svg)](https://agentmods.dev/skills/lugassawan/swe-workbench/principle-api-design)
Your own site
<a href="https://agentmods.dev/skills/lugassawan/swe-workbench/principle-api-design"><img src="https://agentmods.dev/badge/skills/lugassawan/swe-workbench/principle-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 principle-api-design

Your own site · 80×15
<a href="https://agentmods.dev/skills/lugassawan/swe-workbench/principle-api-design"><img src="https://agentmods.dev/badge/skills/lugassawan/swe-workbench/principle-api-design.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 69 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,218 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.00069 $0.01218
Opus 5 $0.00034 $0.00609
Sonnet 5 $0.00014 $0.00244
Haiku 4.5 $0.00007 $0.00122

Measured 6d ago against content hash 3e5e8f175d4d, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

principle-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 6d 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/principle-api-design/SKILL.md · 94 lines

How it starts

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

API Design

An API is a contract. Breaking it breaks callers. Design for evolvability from day one.

Contract-First

Design the interface before the implementation. Write the schema or proto before any code.

  • Contracts force clarity on resource modeling, field names, and error cases early.
  • If the design is painful to describe, the implementation will be painful to use.
  • API review at design time is cheap; API review after clients exist is very expensive.

Versioning

Every breaking change requires a new version. Communicate it, window it, enforce the schedule.

  • Breaking: removing a field, changing a field type, changing semantics of a status code, renaming a resource.
  • Additive (non-breaking): new optional fields, new endpoints, new enum values in response.
  • URL-path versioning (/v1/orders) — visible, cacheable, easy to route; good for major versions.
  • Header versioning (API-Version: 2024-01-01) — cleaner URLs; common for date-based schemes.
  • Set a deprecation window (minimum 6 months for external APIs) and enforce it; sunset headers signal the date.

Idempotency

Operations must be safe to retry. Network failures happen; callers will retry.

  • Safe (GET, HEAD, OPTIONS) — no side effects.
  • Idempotent (PUT, DELETE) — repeating produces the same result.
  • Non-idempotent (POST) — accept an idempotency key header; server deduplicates by key.
  • Key scope: client-generated UUID, tied to the logical operation, expires after a defined window.
  • Return the same response for a duplicate key — do not create twice, do not error.

Pagination

Never return unbounded collections. Choose the model based on query patterns.

  • Offset pagination — simple; breaks when records insert or delete during traversal; fine for small, stable sets.
  • Cursor pagination — stable under concurrent writes; opaque cursor encodes position; cannot jump to page N.
  • Always cap page size server-side; document the default and maximum.
  • Return a next_cursor or next_page token — do not expose the underlying query offset or row ID.

Read the full file on GitHub · 94 lines

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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. 6d ago First seen · 94 lines · 69 tokens per session scan A 3e5e8f175d4d

Subscribe to this mod's changes

principle-api-design is a skill published in the GitHub repository lugassawan/swe-workbench (2 stars, last pushed 4d ago), licensed MIT. It adds 69 tokens to every session and 1,218 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-09-03.

Related

Other skills, from other repositories

code-forge

Generate implementation code from an approved design blueprint or verbal requirements. Composes context anchoring, architecture, clean code, DDD, security, and test quality into an inside-out implementation workflow. Use when moving from design to code, implementing approved contracts, or when the user says…

techygarg/lattice · 81 tokens

slack-block-kit

Proactively apply when generating Slack API payloads with blocks, chat.postMessage calls with structured content, streaming AI responses, or views.open/views.publish calls. Triggers on Block Kit, Slack blocks, section block, actions block, header block, context block, alert block, card block, carousel block, container…

ccheney/robust-skills · 212 tokens

clean-ddd-hexagonal

Proactively apply when designing APIs, microservices, or scalable backend structure. Triggers on DDD, Clean Architecture, Hexagonal, ports and adapters, entities, value objects, domain events, CQRS, event sourcing, repository pattern, use cases, onion architecture, outbox pattern, aggregate root, anti-corruption…

ccheney/robust-skills · 120 tokens

postgres-drizzle

Proactively apply when creating APIs, backends, or data models. Triggers on PostgreSQL, Postgres, Drizzle, drizzle-orm, drizzle-kit, database, schema, pgTable, tables, columns, indexes, queries, migrations, ORM, relations, relational queries, joins, transactions, SQL, connection pooling, PgBouncer, N+1, JSONB, RLS…

ccheney/robust-skills · 119 tokens

functions-development

Build serverless Go or Python functions for Falcon Foundry apps. TRIGGER when user asks to "create a function", "write a serverless function", "build backend logic", runs foundry functions create, or needs help with FDK handler patterns, function testing, or collection integration from functions. Also TRIGGER when…

CrowdStrike/foundry-skills · 195 tokens

go-expert

Use when writing or reviewing Go backend services - go.mod, .go files, net/http handlers, pgx/sqlc database code, goroutines, context.Context plumbing, or failing go test runs. Builds HTTP APIs on the Go 1.22+ stdlib router, fixes error-wrapping and context-cancellation bugs, designs leak-free goroutine lifecycles…

Aarvion-AI/stackwise-skills · 117 tokens