api-design

api-design is a skill for Claude Code, Codex from DevelopersGlobal/ai-agent-skills. It costs 34 tokens per session (710 once invoked), scanned A, original, MIT.

A method for designing software interfaces that other code or services use. It treats an API as a long-term contract, documenting which results and behaviors users can rely on.

In plain words
What is it for?
Designing HTTP endpoints, library functions, and other public interfaces. Planning version changes, documenting stable fields and error behavior, and checking that an interface is difficult to misuse.
Why use it?
It reduces confusing interfaces and accidental breaking changes. Clear examples and documented guarantees make APIs easier to use correctly and safer to extend.

Skill for Claude CodeCodex

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/developersglobal/ai-agent-skills/api-design
Any agent
npx skills add DevelopersGlobal/ai-agent-skills --skill api-design
Clone the repo
git clone --depth 1 https://github.com/DevelopersGlobal/ai-agent-skills

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/developersglobal/ai-agent-skills/api-design.svg)](https://agentmods.dev/skills/developersglobal/ai-agent-skills/api-design)
Your own site
<a href="https://agentmods.dev/skills/developersglobal/ai-agent-skills/api-design"><img src="https://agentmods.dev/badge/skills/developersglobal/ai-agent-skills/api-design.svg" alt="Measured on agentmods" 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 710 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.00034 $0.00710
Opus 5 $0.00017 $0.00355
Sonnet 5 $0.00007 $0.00142
Haiku 4.5 $0.00003 $0.00071

Measured 4d ago against content hash b188642fe0e3, 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 4d 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 · 79 lines

How it starts

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

Overview

APIs are contracts. Once published, every behavior — documented or not — becomes something users depend on (Hyrum's Law). This skill enforces the discipline of designing APIs that are stable, self-documenting, and difficult to misuse.

When to Use

  • Creating any public API endpoint
  • Designing function/library APIs
  • Extending or versioning existing APIs

Process

Step 1: Design the Interface First

  1. Write the usage examples before writing the implementation.
  2. Ask: Is this easy to use correctly? Is it hard to use incorrectly?
  3. Apply the principle of least surprise — the API should do what it looks like it does.
  4. Design for the caller, not the implementer.

Verify: You can write 3 example usages without looking at the implementation.

Step 2: Apply Hyrum's Law

  1. Every observable behavior of your API will be depended upon by someone.
  2. Document what IS and IS NOT guaranteed:
    • Stable: return type, error codes, semantic behavior
    • Unstable: response time, field ordering, internal implementation
  3. Be conservative in what you expose — you can always add, never remove.

Verify: Every public field and behavior is either documented as stable or marked as internal.

Step 3: Versioning Strategy

  1. Version from day one: /api/v1/, Content-Type: application/vnd.myapi.v1+json
  2. Breaking changes require a new version.
  3. Maintain old versions for at least 6 months with deprecation notices.
  4. Additive changes (new optional fields) are non-breaking.

Verify: API version is in the URL or headers. Deprecation policy is documented.

Step 4: Self-Documentation

  1. Every endpoint: purpose, inputs, outputs, error codes — documented.
  2. Error messages tell the caller what went wrong AND how to fix it.
  3. Schema validation on all inputs with meaningful error messages.
  4. OpenAPI/Swagger spec generated (not hand-written).

Verify: A new developer can use the API from documentation alone, without reading source code.

Read the full file on GitHub · 79 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. 4d ago First seen · 79 lines · 34 tokens per session scan A b188642fe0e3

Subscribe to this mod's changes

api-design is a skill published in the GitHub repository DevelopersGlobal/ai-agent-skills (65 stars, last pushed 4mo ago), licensed MIT. It adds 34 tokens to every session and 710 once invoked, about $0.0002 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

code-review-and-quality

Conducts multi-axis code review. Use before merging any change. Use when reviewing code written by yourself, another agent, or a human. Use when you need to assess code quality across multiple dimensions before it enters the main branch.

addyosmani/agent-skills · 51 tokens

constraint-driven-development

Establishes a project's quality bar as a written contract and stops agents quietly lowering it. Interviews the user on which dimensions matter, supplies sane default thresholds when they have no number in mind, records everything in CONSTRAINTS.md, and watches the diff for a weakened bar — new @ts-ignore or…

addyosmani/agent-skills · 154 tokens

performance-optimization

Optimizes application performance across frontend, backend, queries, and databases. Use when performance requirements exist, when you suspect performance regressions, when Core Web Vitals or load times need improvement, when N+1 query patterns need fixing, or when profiling reveals bottlenecks.

addyosmani/agent-skills · 59 tokens

api-and-interface-design

Guides stable API and interface design. Use when designing APIs, module boundaries, or any public interface. Use when creating REST or GraphQL endpoints, defining type contracts between modules, or establishing boundaries between frontend and backend.

addyosmani/agent-skills · 49 tokens

code-simplification

Simplifies code for clarity. Use when refactoring code for clarity without changing behavior. Use when code works but is harder to read, maintain, or extend than it should be. Use when reviewing code that has accumulated unnecessary complexity.

addyosmani/agent-skills · 51 tokens

doubt-driven-development

Subjects every non-trivial decision to a fresh-context adversarial review before it stands. Use when correctness matters more than speed, when working in unfamiliar code, when stakes are high (production, security-sensitive logic, irreversible operations), or any time a confident output would be cheaper to verify now…

addyosmani/agent-skills · 67 tokens