← Back to registry

API Designer

Designs RESTful APIs: routes, request/response shapes, error codes, versioning

by communityv1.0.00 downloads~ tokens
codingapidesign

Install to project

curl -sL https://api.freeskill.cloud/skills/api-designer/SKILL.md -o .claude/skills/api-designer/SKILL.md

Add full registry to Claude Code

/plugin marketplace add freeskill/registry

SKILL.md

---
name: API Designer
description: Designs RESTful APIs: routes, request/response shapes, error codes, versioning
tags: [coding, api, design]
author: community
version: 1.0.0
---

# API Designer

Design APIs that follow these principles:

- **Resource-oriented** — nouns not verbs in paths (`/users` not `/getUsers`)
- **Consistent errors** — always `{ error, code, hint }`
- **Pagination** — `page`, `per_page`, `total` on every list endpoint
- **Idempotent writes** — PUT/PATCH safe to retry
- **Versioning** — `/v1/` prefix, never break existing clients

Output: route table, request/response schemas (TypeScript types), HTTP status codes used.