Agent skill

REST API Design

by secondsky in secondsky/claude-skills

Designs RESTful APIs with proper resource naming, HTTP methods, status codes, and response formats.

MITAuto-check passedBackend & APIs

Install REST API Design

skills CLI
$ npx skills add secondsky/claude-skills --skill rest-api-design -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install secondsky/claude-skills rest-api-design --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/secondsky/claude-skills.git skills-src && mkdir -p .claude/skills && cp -r skills-src/plugins/rest-api-design/skills/rest-api-design .claude/skills/rest-api-design && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
rest-api-design
GitHub stars
227
Used in
1 other repo
Token cost
~552 tokens
SKILL.md length
115 words
Files
1
Skills in repo
169
Repo updated
First seen
Licence
MIT

At a glance

Designs RESTful APIs with proper resource naming, HTTP methods, status codes, and response formats.

  • Building new APIs
  • SKILL.md covers Resource Naming, HTTP Methods, Status Codes and Response Format, plus 3 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
  • Establishing API conventions

What it does

REST API Design is an agent skill from secondsky/claude-skills. Designs RESTful APIs with proper resource naming, HTTP methods, status codes, and response formats. Use when building new APIs, establishing API conventions, or designing developer-friendly interfaces.

Its SKILL.md is about 550 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Backend & APIs, covering REST APIs and Structured output and tool calling. The repository describes itself as: Production-ready skills for Claude Code CLI - Cloudflare, React, Tailwind v4, and AI integrations. The licence is MIT.

When your agent uses it

  • Building new APIs
  • Establishing API conventions
  • Designing developer-friendly interfaces

Example prompts

  • “Use the rest-api-design skill to design RESTful APIs with proper resource naming, HTTP methods, status codes, and response formats”
  • “/rest-api-design”

What it can do on your machine

Read from SKILL.md and the folder at commit 8837836. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are json).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

REST API Design loads about 552 tokens when it runs. Until then it costs about 54 tokens; SKILL.md has 115 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~54
When it runs · the whole SKILL.md, loaded when a task matches
~552

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from secondsky/claude-skills at commit 8837836, republished under its MIT licence (© secondsky). 115 words, ~552 tokens.

Download SKILL.mdSave it as .claude/skills/rest-api-design/SKILL.md (or your agent's skills folder).
name
rest-api-design
description
Designs RESTful APIs with proper resource naming, HTTP methods, status codes, and response formats. Use when building new APIs, establishing API conventions, or designing developer-friendly interfaces.
license
MIT

REST API Design

Design RESTful APIs with proper conventions and developer experience.

Resource Naming

# Good - nouns, plural, hierarchical
GET    /api/users
GET    /api/users/123
GET    /api/users/123/orders
POST   /api/users
PATCH  /api/users/123
DELETE /api/users/123

# Bad - verbs, actions in URL
GET    /api/getUsers
POST   /api/createUser
POST   /api/users/123/delete

HTTP Methods

MethodPurposeIdempotent
GETRead resourceYes
POSTCreate resourceNo
PUTReplace resourceYes
PATCHPartial updateYes
DELETERemove resourceYes

Status Codes

CodeMeaningUse For
200OKSuccessful GET, PATCH
201CreatedSuccessful POST
204No ContentSuccessful DELETE
400Bad RequestValidation errors
401UnauthorizedMissing auth
403ForbiddenInsufficient permissions
404Not FoundResource doesn't exist
429Too Many RequestsRate limited

Response Format

json
{
  "data": {
    "id": "123",
    "type": "user",
    "attributes": {
      "name": "John",
      "email": "john@example.com"
    }
  },
  "meta": {
    "requestId": "req_abc123"
  }
}

Collection Response

json
{
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  },
  "links": {
    "self": "/api/users?page=1",
    "next": "/api/users?page=2"
  }
}

Query Parameters

GET /api/products?category=electronics    # Filtering
GET /api/products?sort=-price,name        # Sorting
GET /api/products?page=2&limit=20         # Pagination
GET /api/products?fields=id,name,price    # Field selection

Best Practices

  • Use nouns for resources, not verbs
  • Version API via URL path (/api/v1/)
  • Return appropriate status codes
  • Include pagination for collections
  • Document with OpenAPI/Swagger

© secondsky, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in plugins/rest-api-design/skills/rest-api-design of secondsky/claude-skills.

Open the folder on GitHubat commit 8837836

Used in 1 other repository

We found 2 copies of this SKILL.md (exact, near-identical or edited) in other folders, from 1 other GitHub owner. This page covers the copy in secondsky/claude-skills, which our catalogue first saw on October 7, 2026.

Compare with similar skills

REST API Design next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

REST API Design compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
REST API Design this skillsecondsky/claude-skills2271 repos~552Automated safety check: PassMIT
API Referencematrixorigin/memoria607—~2.3kAutomated safety check: PassApache-2.0
API Conventionshuangjia2019/claude-code-engineering1.1k1 repos~398Automated safety check: PassNone
API Referencemobazha/mobazha-unified165—~1.7kAutomated safety check: PassMPL-2.0
Adynato Web APImajiayu000/claude-skill-registry6661 repos~2kAutomated safety check: PassMIT
Agentsop HTTP Tool Wrappingagentsope/SkillAlchemy457—~5.9kAutomated safety check: PassMIT

Similar skills

  • API Reference

    matrixorigin/memoria

    Memoria REST API endpoints, request/response formats, auth, rate limits.

    607 GitHub stars~2.3k tokensUpdated today
    Backend & APIsAuto-check passed
  • API Conventions

    huangjia2019/claude-code-engineering

    API design patterns and conventions for this project. An agent skill from huangjia2019/claude-code-engineering.

    1.1k GitHub starsUsed in 1 repo~398 tokens
    Backend & APIsAuto-check passed
  • API Reference

    mobazha/mobazha-unified

    Look up Mobazha backend API endpoints, request/response formats, and field mappings.

    165 GitHub stars~1.7k tokensUpdated 4 days ago
    Backend & APIsAuto-check passed
  • Adynato Web API

    majiayu000/claude-skill-registry

    Web API development conventions for Adynato projects. An agent skill from majiayu000/claude-skill-registry.

    666 GitHub starsUsed in 1 repo~2k tokens
    Backend & APIsAuto-check passed
  • Agentsop HTTP Tool Wrapping

    agentsope/SkillAlchemy

    Decision protocol for wrapping a REST / GraphQL / RPC API as a tool an LLM agent can call.

    457 GitHub stars~5.9k tokensUpdated 1 mo ago
    AI & LLM EngineeringAuto-check passed
  • API Designer

    Jeffallan/claude-skills

    Designs REST and GraphQL APIs from resource modeling to an OpenAPI 3.1 contract, with versioning, pagination and RFC 7807 error handling.

    12k GitHub starsUsed in 2 repos~2k tokens
    Backend & APIsAuto-check passed

More from secondsky/claude-skills

All 169 skills in this repo
  • Tanstack AI

    secondsky/claude-skills

    TanStack AI (alpha) provider-agnostic type-safe chat with streaming for OpenAI, Anthropic, Gemini, Ollama.

    227 GitHub starsUsed in 1 repo~3.6k tokens
    Auto-check: notes
  • Auto Animate

    secondsky/claude-skills

    AutoAnimate (@formkit/auto-animate) zero-config animations for React.

    227 GitHub stars~2.9k tokensUpdated 9 days ago
    Auto-check passed
  • Base UI React

    secondsky/claude-skills

    MUI Base UI unstyled React components with Floating UI. An agent skill from secondsky/claude-skills.

    227 GitHub stars~1.9k tokensUpdated 9 days ago
    Auto-check passed
  • Cloudflare Images

    secondsky/claude-skills

    This skill should be used when the user asks to "upload images to Cloudflare", "implement direct creator upload", "configure image transformations", "optimize WebP/AVIF", "create image variants"…

    227 GitHub stars~3.6k tokensUpdated 9 days ago
    Auto-check: notes
  • Cloudflare Nextjs

    secondsky/claude-skills

    Deploy Next.js to Cloudflare Workers via the OpenNext adapter (@opennextjs/cloudflare).

    227 GitHub stars~5.3k tokensUpdated 9 days ago
    Auto-check: notes
  • Cloudflare Sandbox

    secondsky/claude-skills

    Cloudflare Sandboxes SDK for secure code execution in Linux containers at edge.

    227 GitHub stars~4.5k tokensUpdated 9 days ago
    Auto-check passed

Categories

Questions about REST API Design

What does REST API Design do?

Designs RESTful APIs with proper resource naming, HTTP methods, status codes, and response formats. REST API Design is an agent skill from secondsky/claude-skills. Designs RESTful APIs with proper resource naming, HTTP methods, status codes, and response formats.

When should I use REST API Design?

REST API Design fits situations like: building new APIs; establishing API conventions; designing developer-friendly interfaces.

How do I install REST API Design in Claude Code?

Run `npx skills add secondsky/claude-skills --skill rest-api-design -a claude-code`. Or copy the skill folder (plugins/rest-api-design/skills/rest-api-design in secondsky/claude-skills) into .claude/skills/rest-api-design in your project. Claude Code loads it when a task matches its description.

How do I install REST API Design in Codex?

Run `npx skills add secondsky/claude-skills --skill rest-api-design -a codex`. Or copy the skill folder (plugins/rest-api-design/skills/rest-api-design in secondsky/claude-skills) into .agents/skills/rest-api-design in your project. Codex loads it when a task matches its description.

Can I use REST API Design in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add secondsky/claude-skills --skill rest-api-design -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/rest-api-design, .gemini/skills/rest-api-design, .github/skills/rest-api-design and .opencode/skills/rest-api-design in your project.

What does REST API Design need to run?

SKILL.md names no scripts, command-line tools or credentials: REST API Design is instructions for the agent only.

Does REST API Design access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is REST API Design safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does REST API Design use?

REST API Design is published under the MIT licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does REST API Design use?

About 552 tokens (SKILL.md is roughly 2.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to REST API Design?

Skills that share tags, products or a category with REST API Design: API Reference (matrixorigin/memoria, 607 stars), API Conventions (huangjia2019/claude-code-engineering, 1.1k stars), API Reference (mobazha/mobazha-unified, 165 stars) and Adynato Web API (majiayu000/claude-skill-registry, 666 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains REST API Design?

secondsky (a GitHub user) maintains it in secondsky/claude-skills, which has 227 GitHub stars. The repository holds 169 skills in this directory. The repository was last updated on September 28, 2026.

Source: secondsky/claude-skills on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.