api-design-plan

api-design-plan is a skill for Claude Code, Codex from DongDuong2001/pudo-code-system. It costs 14 tokens per session (184 once invoked), scanned A, original, MIT.

A planning guide for defining how software components communicate through an application programming interface (API), including its rules and data formats.

In plain words
What is it for?
Use it when planning REST, GraphQL, or gRPC APIs, documenting them with OpenAPI or Swagger, and deciding authentication, permissions, pagination, filtering, and deprecation rules.
Why use it?
It helps keep endpoints consistent, secure, versioned, and able to handle large or changing amounts of data.

Skill for Claude CodeCodex

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

Good fit Use it when planning REST, GraphQL, or gRPC APIs, documenting them with OpenAPI or Swagger, and deciding authentication, permissions, pagination, filtering, and deprecation rules.

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

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

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/dongduong2001/pudo-code-system/api-design"><img src="https://agentmods.dev/badge/skills/dongduong2001/pudo-code-system/api-design.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 14 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 184 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.00014 $0.00184
Opus 5.5 $0.00006 $0.00074
Sonnet 5.5 $0.00003 $0.00037
Haiku 4.5 $0.00001 $0.00018

Measured 1mo ago against content hash b96b2a589ea2, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

api-design-plan 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 1mo 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/plan/api-design/SKILL.md · 20 lines

What it actually says

API Design Skill

This skill is utilized during the PLAN phase when defining the contract between different services or between a client and a backend.

When to use this skill

  • When defining RESTful endpoints, GraphQL schemas, or gRPC definitions.
  • When creating API documentation (OpenAPI/Swagger).
  • When planning API versioning and deprecation strategies.

Guidelines

  • Consistency: Maintain consistent naming conventions (e.g., standardizing on plural nouns for REST collections).
  • Versioning: Plan for API versioning from Day 1 (e.g., /v1/users).
  • Pagination & Filtering: Design endpoints to handle large datasets natively.
  • Security: Ensure authentication (OAuth2, JWT) and authorization (RBAC/ABAC) are built into the design.
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. 1mo ago First seen · 20 lines · 14 tokens per session scan A b96b2a589ea2

Subscribe to this mod's changes

api-design-plan is a skill published in the GitHub repository DongDuong2001/pudo-code-system (5 stars, last pushed 13d ago), licensed MIT. It adds 14 tokens to every session and 184 once invoked, about $0.0001 per session on Opus 5.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-31.

Related

Other skills, from other repositories

scale-to-millions

Use this skill whenever the user is designing, reviewing, debugging, or answering interview questions about system/software architecture and scalability — e.g. "scale my app", "how do I handle more traffic", "design a URL shortener / news feed / chat system", "my API is slow under load", "should I shard my database"…

Rudra-narayan-muduli-001/Scale-to-Millions · 130 tokens

architecture

Proactive architecture review — explore codebase structure, generate a self-contained HTML report with Mermaid diagrams and candidate improvements, then grill the findings. Use when planning a large refactor, onboarding to an unfamiliar codebase, or before a major architectural change.

datit309/supergraph · 52 tokens

demographic-modeling

This skill should be used when the user asks to "design a demographic model", "model a person/organisation/role", "design party relationships", "plan identity structures", or "work with demographic archetypes". Covers designing openEHR demographic models using the PARTY hierarchy, roles, capabilities, relationships…

Cadasto/openehr-assistant-plugin · 126 tokens

jq

Trigger on: jq, jq filter, jq query, process JSON, filter JSON, transform JSON, extract from JSON, parse API response JSON, NDJSON, pretty-print JSON, jq select, groupby JSON, update JSON file with jq. Specialized procedure for complex JSON processing with the jq CLI. Prefer over ad-hoc Python/Node one-offs for…

tkolleh/skills · 105 tokens

fastapi-pro

Production FastAPI patterns — async endpoints, SQLAlchemy 2.0 async, Pydantic V2, dependency injection, JWT auth, testing. Use for Python 3.11+ FastAPI backends. NOT for Django (→ django-patterns) or Node.js (→ backend-patterns).

tranhieutt/software_development_department · 67 tokens

laravel-patterns

Provides Laravel PHP patterns for Eloquent ORM, Artisan commands, queues, middleware, and API resources. Use when working with PHP Laravel files (.php) or when the user mentions Laravel, Eloquent, or PHP framework.

tranhieutt/software_development_department · 49 tokens