api-designer

api-designer is a skill for Claude Code from Jeffallan/claude-skills. It costs 39 tokens per session (1,849 once invoked), scanned A, original, MIT.

A guide for designing REST and GraphQL interfaces and writing OpenAPI 3.1 specifications. It covers resources, URLs, requests, responses, errors, pagination, and version changes.

In plain words
What is it for?
Use it to model data, define endpoints and schemas, choose versioning and pagination approaches, standardize errors, validate an OpenAPI file, and test it with a mock server.
Why use it?
It turns business requirements into a consistent interface contract that client and server developers can check against.

Skill for Claude Code

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

Part of the fullstack-dev-skills plugin — 57 skills shipped together

not rated 11krepo +54 1mo ago A scan Socket: passSnyk: passSkillSpector: warn 39 tokens original MIT

Good fit Use it to model data, define endpoints and schemas, choose versioning and pagination approaches, standardize errors, validate an OpenAPI file, and test it with a mock server.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/jeffallan/claude-skills/api-designer
About the project

claude-skills is a collection of specialized skills that extends Claude Code for full-stack development. Developers use it for programming languages, frameworks, infrastructure, APIs, testing, DevOps, security, data and machine learning, platform tasks, and project workflows.

Jeffallan/claude-skills · 11,380 stars · on GitHub

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 Jeffallan/claude-skills --skill api-designer
Clone the repo
git clone --depth 1 https://github.com/Jeffallan/claude-skills

Made for: Claude Code.

Or install fullstack-dev-skills, the plugin that ships this one along with the rest of its 57 skills.

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/jeffallan/claude-skills/api-designer/github.svg)](https://agentmods.dev/skills/jeffallan/claude-skills/api-designer)
Your own site
<a href="https://agentmods.dev/skills/jeffallan/claude-skills/api-designer"><img src="https://agentmods.dev/badge/skills/jeffallan/claude-skills/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/jeffallan/claude-skills/api-designer"><img src="https://agentmods.dev/badge/skills/jeffallan/claude-skills/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,849 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. Third-party audits
  • Socket pass 29 Apr 2026
  • Snyk pass 29 Apr 2026
  • NVIDIA SkillSpector warn 7 Sept 2026
SkillSpector: 5 findings, up to medium

These are SkillSpector’s own severities. On a checked sample its high-severity flags on skills were ~96% false positives — a documented command, a public API, a “never do X” rule — so we show them as a caution to read, not a verdict. Why →

  • medium MCP Rug Pull · line 25
    npx commands without a version suffix (e.g. @1.0.0) create a rug-pull risk if the upstream server is compromised and publishes a malicious update.
    Fix: Pin the version: npx @scope/[email protected]
  • medium MCP Rug Pull · line 213
    npx commands without a version suffix (e.g. @1.0.0) create a rug-pull risk if the upstream server is compromised and publishes a malicious update.
    Fix: Pin the version: npx @scope/[email protected]
  • medium MCP Rug Pull · line 26
    npx commands without a version suffix (e.g. @1.0.0) create a rug-pull risk if the upstream server is compromised and publishes a malicious update.
    Fix: Pin the version: npx @scope/[email protected]
  • medium Data Exfiltration · line 143
    Data is being sent to an external URL. This could be legitimate telemetry or data exfiltration. Manual review is recommended.
    Fix: Verify the destination URL is trusted and necessary. Remove or replace with documented APIs. Ensure no secrets, tokens, or PII are transmitted.
  • medium Data Exfiltration · line 187
    Data is being sent to an external URL. This could be legitimate telemetry or data exfiltration. Manual review is recommended.
    Fix: Verify the destination URL is trusted and necessary. Remove or replace with documented APIs. Ensure no secrets, tokens, or PII are transmitted.
How audits are shown
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.00039 $0.01849
Opus 5 $0.00019 $0.00924
Sonnet 5 $0.00008 $0.00370
Haiku 4.5 $0.00004 $0.00185

Measured 9d ago against content hash 75a1d0df1264, 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 9d 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

Copies of this mod

2 near-identical copies found in the catalogue:

skills/api-designer/SKILL.md · 220 lines

How it starts

The opening of the file, as written. The whole thing — 220 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 · 220 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. 9d ago First seen · 220 lines · 39 tokens per session scan A 75a1d0df1264

Subscribe to this mod's changes

api-designer is a skill published in the GitHub repository Jeffallan/claude-skills (11,380 stars, last pushed 1mo ago), licensed MIT. It adds 39 tokens to every session and 1,849 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

dotnet-graphql

Guides implementation of GraphQL with HotChocolate in .NET 8 projects following Clean Architecture. Creates the GraphQL project with single or multi-schema design, queries returning IQueryable for EF Core optimization, type extensions for computed fields, field hiding, error logging, and DI registration. Use when…

landim32/awesome-ai-skills · 79 tokens

dotnet-multi-tenant

Implements Multi-Tenant pattern in .NET APIs with per-tenant database isolation, per-tenant JWT secrets, ACL layer with automatic TenantId propagation via DelegatingHandler, and dynamic DbContext factory. Covers TenantMiddleware, TenantContext, TenantResolver, TenantHeaderHandler, TenantDbContextFactory, and dynamic…

landim32/awesome-ai-skills · 72 tokens

nnews-guide

Guides how to integrate the NNews NuGet package for consuming the NNews CMS API in a .NET 8 project. Use when the user wants to consume articles, categories, tags, images, or AI-powered content generation from the NNews API.

landim32/awesome-ai-skills · 56 tokens

dotnet-architecture

Guides implementation of Clean Architecture in .NET projects. Covers all layers: DTO, Domain (Models, Services, Enums), Infra.Interfaces (Repository, AppServices), Infra (Context, Repository, AppServices), and Application (DI/Startup). Use when creating entities, services, repositories, or restructuring architecture.…

landim32/awesome-ai-skills · 82 tokens

ztools-guide

Guides how to integrate the zTools package for ChatGPT, DALL-E image generation, file upload (S3), slug generation, email sending, and document validation in a .NET 8 project. Use when the user wants to use AI features, upload files, generate slugs, send emails, or understand zTools integration.

landim32/awesome-ai-skills · 72 tokens

nauth-guide

Guides how to integrate the NAuth package for user authentication in a .NET 8 project. Use when the user wants to add authentication, configure NAuth, use IUserClient, or understand the NAuth authentication flow.

landim32/awesome-ai-skills · 49 tokens