Rest API Design

REST API design with semantic HTTP methods, status codes, and resource modeling. Use when designing new APIs or reviewing existing API designs.

48 stars 10 forksSoftware Development Plugin marketplace

Install

Claude Code plugin
/plugin marketplace add sethdford/claude-skills

The repo is a Claude Code plugin marketplace. Run /plugin afterwards to pick the plugin that includes this skill.

skills CLI (Claude Code, Cursor, Codex and more)
npx skills add sethdford/claude-skills --skill rest-api-design
Manual install
git clone --depth 1 https://github.com/sethdford/claude-skills.git /tmp/claude-skills
mkdir -p ~/.claude/skills
cp -r /tmp/claude-skills/engineer/api-development/skills/rest-api-design ~/.claude/skills/rest-api-design

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# REST API Design

Designing HTTP APIs following REST principles: resources (nouns), methods (verbs), semantic status codes, and hypermedia.

## Context

You are designing or reviewing a REST API. Your role is to:

- Identify resources in the domain
- Map CRUD operations to HTTP methods semantically
- Use status codes correctly (not 200 for errors)
- Design URLs as resources, not RPC endpoints
- Consider idempotency and caching implications

REST is architectural style, not HTTP CRUD framework. Treat it with discipline.

## Domain Context

Based on Roy Fielding's dissertation and REST maturity model (Richardson Level 0-3):

- **Resources**: Nouns (users, orders, products). Identified by URLs.
- **HTTP Methods**: GET (read), POST (create), PUT (replace all), PATCH (partial), DELETE (remove)
- **Status Codes**: 1xx (info), 2xx (success), 3xx (redirect), 4xx (client error), 5xx (server error)
- **Idempotency**: GET, PUT, DELETE are idempotent. POST is not.
- **Hypermedia**: Links in responses guide clients to related resources
- **Statelessness**: Each request contains all context needed; no session state on server

## When to Use This Skill

- Designing a new public API
- Auditing existing API for REST compliance
- Deciding between REST, gRPC, or GraphQL
- Designing complex resource hierarchies
- Handling pagination, filtering, or versioning

## Prerequisites

- Understand domain entities and relationships
- Know HTTP methods and status codes (or willing to learn)
Read the full skill on GitHub

Details

Skill name
rest-api-design
Path
engineer/api-development/skills/rest-api-design/SKILL.md
License
MIT
Repo updated
11 March 2026

FAQ

What does the Rest API Design skill do?

REST API design with semantic HTTP methods, status codes, and resource modeling. Use when designing new APIs or reviewing existing API designs.

How do I install the Rest API Design skill?

Claude Code plugin: /plugin marketplace add sethdford/claude-skills. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is Rest API Design popular?

It lives in sethdford/claude-skills, which has 48 GitHub stars and 10 forks.

Related skills

Browse the most popular Claude skills, all software development skills, or write your own with the skills generator.