Comprehensive REST API design review with automated linting, breaking-change detection, and design scorecards. Catches inconsistent conventions, missing versioning, and design smells before APIs ship. Use when reviewing a PR that adds or changes API endpoints, auditing an existing API for v2 migration, or establishing API standards for a team.
api-design-principles
api-design-principles is an open-source backend skill for Claude Code and compatible agents, published by wshobson. Its author describes it as: “Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers. Use when designing new APIs, reviewing API specifications, or establishing API design standards.”. The project has 39k stars on GitHub and is available under the MIT license. Add it to your setup with `/plugin marketplace add wshobson/agents`.
What api-design-principles does
Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.
Installation
Add api-design-principles to your agent with:
/plugin marketplace add wshobson/agentsAlways review a skill's source before installing it. This command comes from the skill's public repository; the linked repo is the source of truth for exact setup steps.
What's inside
The SKILL.md for api-design-principles is organised into these sections:
- When to Use This Skill
- Core Concepts
- 1. RESTful Design Principles
- 2. GraphQL Design Principles
- 3. API Versioning Strategies
- Detailed patterns and worked examples
- Best Practices
- REST APIs
- GraphQL APIs
- Common Pitfalls
When to use it
Reach for api-design-principles when you want backend help from your agent without writing the same instructions every session. Load the skill and the agent picks it up automatically for relevant tasks.
Strengths
- Clear MIT license — safe to read and adapt
- Ships in wshobson/agents, an established project with 38,890 GitHub stars
- Actively maintained (recent commits)
Topics
Frequently asked questions
- What does api-design-principles do?
- Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers. Use when designing new APIs, reviewing API specifications, or establishing API design standards.
- How do I install api-design-principles?
- Run /plugin marketplace add wshobson/agents in your agent, then reload your skills. Review the source at https://github.com/wshobson/agents before installing.
- Is api-design-principles free to use?
- Yes. api-design-principles is free and open source under the MIT license, so you can read, run, and adapt it within that license's terms.
- Where does api-design-principles come from?
- api-design-principles ships inside wshobson/agents, a repository that contains 54 catalogued skills in total. The repository's 38,890 GitHub stars apply to that whole collection, not to this skill on its own.
Related skills
More Backend →Use when the user asks to generate API tests, create integration test suites, test REST endpoints, or build contract tests.
MUST USE for ANY work on .py .pyi .rs .ts .tsx .mts .cts .go files. One philosophy: strict types, modern stacks (Pydantic v2 / serde+thiserror / Zod / gin+sqlc+pgx+slog), modern toolchains (uv+basedpyright+ruff / cargo+clippy+miri / Bun+Biome+tsc / gofumpt+golangci-lint v2+nilaway+go-race), parse-don't-validate, exhaustive match, typed errors, no any/unwrap/panic, 250 LOC ceiling, TDD, consumer-routed logging. Routes to references/{python,rust,typescript,rust-ub,go}/ + references/logging.md. Triggers: write/edit Python/Rust/TypeScript/Go code, new project, gin server, bubbletea TUI, CJK IME, connect-go RPC, sqlc pgx, branded ids, exhaustive match, unsafe Rust, miri, oversized file, refactor, TDD, e2e test, logging, log levels, structured logging, observability, arena, allocator, bumpalo, const fn, const generics, comptime, zero-alloc, bitfield, repr, scopeguard, errdefer, Zig-like, zerocopy, packed struct.
查询 AIHOT 的中文 AI 资讯、精选、当前热点和日报。用户询问今天或最近的 AI 新闻、AI 圈动态、大模型或产品发布、OpenAI／Anthropic／Google 最新消息、AI 论文、AI 日报、AIHOT 精选、当前最热事件，或需要同步当前全部精选时使用。必须通过 aihot.virxact.com 的匿名只读 API 获取当前数据，不凭训练记忆回答新闻；不需要 API Key 或 MCP server。
This skill helps users extract structured best-selling product data from Amazon via the BrowserAct API. Agent should proactively apply this skill when users express needs like search for best selling products on Amazon, extract Amazon product data based on keywords, find top rated Amazon products, monitor Amazon competitor prices and sales, discover trending products on Amazon marketplace, extract Amazon product titles prices and ratings, gather Amazon product sales volume for market research, search Amazon best sellers in specific region, collect Amazon product reviews and promotion details, analyze Amazon product availability and badges, get Amazon product data for market analysis.