API Design Patterns

by xu-xiang

API Design Patterns is a DevOps skill for Claude Code, published by xu-xiang in everything-claude-code-zh.

1.9K stars307 forkson xu-xiang/everything-claude-code-zhAdded 2026/08/18+1% in starsRepository updated 2026/03/05

View source on GitHub Download repo ZIP

ai-agentsanthropicclaudeclaude-codedeveloper-toolseverything-claude-codellmmcponeskillproductivity

Install in seconds

Install API Design Patterns

Copy API Design Patterns into your Claude Code skills folder. Run the command in your terminal, or review the source on GitHub before installing.

terminal

npx degit https://github.com/xu-xiang/everything-claude-code-zh/tree/main/skills/api-design ~/.claude/skills/api-design

Requires Node.js. Downloads this skill only — not the rest of the repository — into your Claude Code skills folder.

Without Node.js

git clone https://github.com/xu-xiang/everything-claude-code-zh.git

Clones the whole repository, then copy the skill’s own directory into your skills folder yourself.

In this catalog

Source file: skills/api-design/SKILL.md in xu-xiang/everything-claude-code-zh
Installs to: ~/.claude/skills/api-design
Collection: One of 25 skills cataloged from this repository
Category: DevOps — 798 skills

What API Design Patterns does

API Design Patterns provides conventions and best practices for designing consistent, developer-friendly REST APIs, including resource naming, HTTP status codes, pagination, filtering, error responses, versioning, and rate limiting.

API Design Patterns is cataloged under DevOps on DirSkills. API Design Patterns comes from a repository tagged ai-agents, anthropic, claude, claude-code and developer-tools.

Documentation

README

Excerpt

API 设计模式 (API Design Patterns)

设计一致且开发者友好的 REST API 的规范与最佳实践。

何时启用

设计新的 API 端点 (Endpoints)
审查现有的 API 合约 (Contracts)
添加分页、过滤或排序功能
为 API 实现错误处理
规划 API 版本控制策略
构建公开或面向合作伙伴的 API

资源设计 (Resource Design)

URL 结构

# 资源是名词、复数、小写、短横线命名 (kebab-case)
GET    /api/v1/users
GET    /api/v1/users/:id
POST   /api/v1/users
PUT    /api/v1/users/:id
PATCH  /api/v1/users/:id
DELETE /api/v1/users/:id

# 关系子资源
GET    /api/v1/users/:id/orders
POST   /api/v1/users/:id/orders

# 不属于 CRUD 的操作（谨慎使用动词）
POST   /api/v1/orders/:id/cancel
POST   /api/v1/auth/login
POST   /api/v1/auth/refresh

命名规则

This is the opening of the README. Read the full README on GitHub.

Frequently asked about API Design Patterns

What else does xu-xiang publish alongside API Design Patterns?
API Design Patterns is one of 25 skills that DirSkills catalogs from xu-xiang/everything-claude-code-zh, the repository it ships in. Its siblings there include Article Writing, Autonomous Loops and Backend Patterns. Each one is a separate skill with its own page in this directory, installs the same way API Design Patterns does, and is maintained by xu-xiang in that same repository. The rest of the collection is listed on the xu-xiang/everything-claude-code-zh page.
How does API Design Patterns compare to other DevOps skills?
API Design Patterns ranks #277 by stars among the 798 DevOps skills in this catalog. The most-starred ones next to it are Backend Patterns, API Connector Builder and Migration. DirSkills ranks by the star count of the repository each skill ships in, so that order reflects how popular those repositories are rather than any review of API Design Patterns against them. Open each page to compare what they document and how they install.