rest-api-design

rest-api-design is a skill for Claude Code from berkcangumusisik/claude-code-practices. It costs 14 tokens per session (325 once invoked), scanned A, original, MIT.

A REST API design and review guide for web endpoints that exchange data using standard HTTP methods and resource-based URLs.

In plain words
What is it for?
Use it to review existing endpoints or create route tables with methods, URL patterns, data shapes, and error codes.
Why use it?
It helps prevent inconsistent routes, incorrect status codes, missing pagination, and confusing request or response formats.

Skill for Claude Code

Written for Claude Code: allowed-tools in frontmatter.

Good fit Use it to review existing endpoints or create route tables with methods, URL patterns, data shapes, and error codes.

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

Made for: Claude Code.

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 rest-api-design

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/berkcangumusisik/claude-code-practices/rest-api-design"><img src="https://agentmods.dev/badge/skills/berkcangumusisik/claude-code-practices/rest-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 325 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.00325
Opus 5 $0.00007 $0.00162
Sonnet 5 $0.00003 $0.00065
Haiku 4.5 $0.00001 $0.00032

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

Security

Grade A, and why

rest-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/rest-api-design/SKILL.md · 47 lines

What it actually says

REST API Design

Resource / Scope: $ARGUMENTS

If reviewing existing API:

  1. Read route definitions:
grep -rn "router\.\|app\." src/ --include="*.ts" | grep -E "get|post|put|patch|delete" | head -30

Check for:

  • Proper HTTP method usage (GET=read, POST=create, PUT/PATCH=update, DELETE=remove)
  • Consistent URL naming (/users not /getUsers)
  • Plural nouns for collections (/users/123)
  • Nested resources for relationships (/users/123/posts)
  • Query params for filtering/sorting/pagination, not URL segments
  • Consistent response shapes
  • Missing pagination on list endpoints
  • HTTP status codes correct (201 for creation, 204 for delete, etc.)

If designing new API:

Generate the complete route table:

GET    /resources          List (with pagination)
POST   /resources          Create
GET    /resources/:id      Get one
PUT    /resources/:id      Replace
PATCH  /resources/:id      Partial update
DELETE /resources/:id      Delete

GET    /resources/:id/related   Nested resource

Include request/response shapes and error codes for each endpoint.

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 · 47 lines · 14 tokens per session scan A 82230b105638

Subscribe to this mod's changes

rest-api-design is a skill published in the GitHub repository berkcangumusisik/claude-code-practices (10 stars, last pushed 4mo ago), licensed MIT. It adds 14 tokens to every session and 325 once invoked, about $0.0001 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

x402

Set up Browser Use Cloud payments with x402 — pay per request from a crypto wallet (USDC on Base mainnet), no signup or API key. Two setups it works out up front — "just use it" (set up a wallet so you or Claude Code can run cloud browser tasks paid from the wallet — Claude writes and runs throwaway scripts, nothing…

browser-use/browser-use · 175 tokens

cloud

Documentation reference for using Browser Use Cloud — the hosted API and SDK for browser automation. Use this skill whenever the user needs help with the Cloud REST API (v2, v3, or v4), browser-use-sdk (Python or TypeScript), X-Browser-Use-API-Key authentication, cloud sessions, browser profiles, profile sync, CDP…

browser-use/browser-use · 177 tokens

open-source

Documentation reference for writing Python code using the browser-use open-source library. Use this skill whenever the user needs help with Agent, Browser, or Tools configuration, is writing code that imports from browseruse, asks about @sandbox deployment, supported LLM models, Actor API, custom tools, lifecycle…

browser-use/browser-use · 137 tokens

authentication-patterns

OAuth 2.0, JWT, SSO, MFA, NextAuth/Clerk/Supabase Auth implementation patterns.

travisjneuman/.claude · 28 tokens

email-systems

Transactional email (Resend, SendGrid, SES), templates (React Email, MJML), deliverability (SPF/DKIM/DMARC), and inboxing best practices. Use when building email infrastructure, designing templates, or troubleshooting deliverability.

travisjneuman/.claude · 55 tokens

event-driven-architecture

Kafka, RabbitMQ, SQS/SNS, event sourcing, CQRS, saga patterns, dead letter queues, and idempotency. Use when designing asynchronous systems, implementing message-driven workflows, or building event streaming pipelines.

travisjneuman/.claude · 50 tokens