wshobson/agents✦ 精选0°

api-design-principles

仓库创建 2025年7月25日最近提交 4 天前SkillHot 收录 20 天前
▸ 精选理由

帮助统一接口设计标准并提升开发者体验与可维护性。

这个 Skill 做什么

提供 REST 与 GraphQL 的设计原则、规范与评审要点。

教你怎么设计让开发者喜欢用且好维护的 REST 与 GraphQL 接口,覆盖命名、版本、错误与分页等常见细节。在新建 API、评审规范或把老接口重构时最有用。特别关注一致性契约、向后兼容和可扩展性,能让客户端和服务端对接更顺畅、少返工。

▸ 展开 SKILL.md 英文原文

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.

开发编程API设计RESTGraphQL通用
3.8w
Stars
4.1k
Forks
40
仓库内 Skill
+683
7 日增星
安装 / 使用
给你的 Agent 一句话(通用)
帮我安装这个 skill:https://raw.githubusercontent.com/wshobson/agents/main/plugins/backend-development/skills/api-design-principles/SKILL.md
或 curl 直取 SKILL.md
curl -fsSL "https://raw.githubusercontent.com/wshobson/agents/main/plugins/backend-development/skills/api-design-principles/SKILL.md"
SKILL.MD 节选查看完整文件 ↗
# API Design Principles

Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.

## When to Use This Skill

- Designing new REST or GraphQL APIs
- Refactoring existing APIs for better usability
- Establishing API design standards for your team
- Reviewing API specifications before implementation
- Migrating between API paradigms (REST to GraphQL, etc.)
- Creating developer-friendly API documentation
- Optimizing APIs for specific use cases (mobile, third-party integrations)

## Core Concepts

### 1. RESTful Design Principles

**Resource-Oriented Architecture**

- Resources are nouns (users, orders,
via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有