api-designer

api-designer is a skill for Claude Code, Codex from eric861129/SKILLS_All-in-one. It costs 39 tokens per session (1,825 once invoked), scanned A, a copy of api-designer, MIT.

An API design guide for planning REST and GraphQL services and writing OpenAPI 3.1 specifications. It covers resources, endpoints, request and response formats, and API changes over time.

In plain words
What is it for?
Use it to model resources, choose URL and HTTP method patterns, define an OpenAPI contract, validate it, mock the API, and plan pagination, versioning, and deprecation.
Why use it?
It helps prevent unclear interfaces, inconsistent errors, breaking changes, and misunderstandings between an API and the software that uses it.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Use it to model resources, choose URL and HTTP method patterns, define an OpenAPI contract, validate it, mock the API, and plan pagination, versioning, and deprecation.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/eric861129/skills_all-in-one/api-designer
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 eric861129/SKILLS_All-in-one --skill api-designer
Clone the repo
git clone --depth 1 https://github.com/eric861129/SKILLS_All-in-one

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-designer

README.md
[![agentmods](https://agentmods.dev/badge/skills/eric861129/skills_all-in-one/api-designer/github.svg)](https://agentmods.dev/skills/eric861129/skills_all-in-one/api-designer)
Your own site
<a href="https://agentmods.dev/skills/eric861129/skills_all-in-one/api-designer"><img src="https://agentmods.dev/badge/skills/eric861129/skills_all-in-one/api-designer/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-designer

Your own site · 80×15
<a href="https://agentmods.dev/skills/eric861129/skills_all-in-one/api-designer"><img src="https://agentmods.dev/badge/skills/eric861129/skills_all-in-one/api-designer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 39 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,825 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 94% copy Near-identical to another mod 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.00039 $0.01825
Opus 5 $0.00019 $0.00912
Sonnet 5 $0.00008 $0.00365
Haiku 4.5 $0.00004 $0.00183

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

Security

Grade A, and why

api-designer 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.

Origin

This is a copy

94% identical to api-designer — 2 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

public/SKILLS/Development & Code Tools/api-designer/SKILL.md · 218 lines

How it starts

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

API Designer

Senior API architect specializing in REST and GraphQL APIs with comprehensive OpenAPI 3.1 specifications.

Core Workflow

  1. Analyze domain — Understand business requirements, data models, and client needs
  2. Model resources — Identify resources, relationships, and operations; sketch entity diagram before writing any spec
  3. Design endpoints — Define URI patterns, HTTP methods, request/response schemas
  4. Specify contract — Create OpenAPI 3.1 spec; validate before proceeding: npx @redocly/cli lint openapi.yaml
  5. Mock and verify — Spin up a mock server to test contracts: npx @stoplight/prism-cli mock openapi.yaml
  6. Plan evolution — Design versioning, deprecation, and backward-compatibility strategy

Reference Guide

Load detailed guidance based on context:

Topic Reference Load When
REST Patterns references/rest-patterns.md Resource design, HTTP methods, HATEOAS
Versioning references/versioning.md API versions, deprecation, breaking changes
Pagination references/pagination.md Cursor, offset, keyset pagination
Error Handling references/error-handling.md Error responses, RFC 7807, status codes
OpenAPI references/openapi.md OpenAPI 3.1, documentation, code generation

Constraints

MUST DO

  • Follow REST principles (resource-oriented, proper HTTP methods)
  • Use consistent naming conventions (snake_case or camelCase — pick one, apply everywhere)
  • Include comprehensive OpenAPI 3.1 specification
  • Design proper error responses with actionable messages (RFC 7807)
  • Implement pagination for all collection endpoints
  • Version APIs with clear deprecation policies
  • Document authentication and authorization
  • Provide request/response examples

MUST NOT DO

  • Use verbs in resource URIs (use /users/{id}, not /getUser/{id})
  • Return inconsistent response structures
  • Skip error code documentation
  • Ignore HTTP status code semantics
  • Design APIs without a versioning strategy
  • Expose implementation details in the API surface
  • Create breaking changes without a migration path
  • Omit rate limiting considerations

Read the full file on GitHub · 218 lines

Files

What ships with it

5 files 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 · 218 lines · 39 tokens per session scan A 185d4b3c6cae

Subscribe to this mod's changes

api-designer is a skill published in the GitHub repository eric861129/SKILLS_All-in-one (52 stars, last pushed 4mo ago), licensed MIT. It adds 39 tokens to every session and 1,825 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. It is 94% identical to api-designer, differing in 2 lines, and is treated as a copy.

Related

Other skills, from other repositories

architect

This skill should be used when the user asks to "design system architecture", "evaluate microservices vs monolith", "create architecture diagrams", "analyze dependencies", "choose a database", "plan for scalability", "make technical decisions", or "review system design".

Joncik91/ucai · 56 tokens

backend

This skill should be used when the user asks to "design REST APIs", "optimize database queries", "implement authentication", "build microservices", "review backend code", "set up GraphQL", "handle database migrations", or "load test APIs".

Joncik91/ucai · 54 tokens

clerk-knowledge-patch

Use this guide when implementing, upgrading, or debugging Clerk authentication, authorization, Organizations, Billing, SDKs, components, or deployment architecture. Start with the migration notes, then open the matching reference.

Nevaberry/nevaberry-plugins · 9 tokens

apache-kafka-knowledge-patch

Use this skill when upgrading, configuring, extending, or operating Apache Kafka and its clients, Kafka Streams, Kafka Connect, MirrorMaker, KRaft, share groups, or tiered storage. Inspect the project's actual broker, client, metadata, and Java versions before applying version-dependent advice.

Nevaberry/nevaberry-plugins · 10 tokens

aspnet-core-knowledge-patch

Use this patch when implementing, reviewing, testing, or upgrading ASP.NET Core applications. Check breaking behavior first, then open only the topic references relevant to the task.

Nevaberry/nevaberry-plugins · 11 tokens

authjs-knowledge-patch

Use this patch to choose the maintained authentication path, avoid security-sensitive provider mistakes, and apply current Auth.js integration patterns. Read the topic reference before changing an affected flow; the quick reference prioritizes breaking behavior, security updates, and common implementation work.

Nevaberry/nevaberry-plugins · 9 tokens