rest_design_rules

REST API Design Rules Reference

Content Preview
# REST API Design Rules Reference

## Core Principles

### 1. Resources, Not Actions
REST APIs should focus on **resources** (nouns) rather than **actions** (verbs). The HTTP methods provide the actions.

```
✅ Good:
GET    /users           # Get all users
GET    /users/123       # Get user 123
POST   /users           # Create new user
PUT    /users/123       # Update user 123
DELETE /users/123       # Delete user 123

❌ Bad:
POST   /getUsers
POST   /createUser
POST   /updateUser/123
POST   /del
How to Use

Recommended: Install to project (local)

mkdir -p .claude/skills
curl -o .claude/skills/rest_design_rules.md \
  https://raw.githubusercontent.com/alirezarezvani/claude-skills/main/engineering/api-design-reviewer/references/rest_design_rules.md

Skill is scoped to this project only. Add .claude/skills/ to your .gitignoreif you don't want to commit it.

Alternative: Clone full repo

git clone https://github.com/alirezarezvani/claude-skills

Then reference at engineering/api-design-reviewer/references/rest_design_rules.md

Related Skills