api-design

仓库创建 2026年7月25日最近提交 1 天前SkillHot 收录 11 小时前

▸ 精选理由

以开发者体验和向后兼容为核心，适合后端与产品设计阶段使用。

这个 Skill 做什么

为生产环境设计一致、可维护的REST/GraphQL/gRPC等API规范。

帮你把接口设计成可上线的 API：可做 REST、GraphQL、gRPC 或 WebSocket 的端点、版本策略、错误格式与分页设计，并能输出 OpenAPI/Swagger 规范。适合在开工前定契约或在选型（REST vs GraphQL）时用，避免上线后频繁改动。强调一致性和良好开发者体验，让 API 像产品一样好用。

▸ 展开 SKILL.md 英文原文

Design production-grade APIs — REST, GraphQL, gRPC, and WebSocket — with a focus on consistency, versioning, error standards, and developer experience. Use when the user asks to design an API, define endpoints, choose between REST and GraphQL, structure request/response schemas, handle API versioning, design pagination, or produce an OpenAPI/Swagger spec.

开发编程API设计REST/GraphQL版本控制错误规范通用

Stars

Forks

仓库内 Skill

积累中

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/CODE-SAURABH/OpenSkills/main/api-design/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/CODE-SAURABH/OpenSkills/main/api-design/SKILL.md"

SKILL.MD 节选查看完整文件 ↗

# API Design

Approach every API as a product. The developer calling your API is your user. An API that is hard to understand, inconsistent, or unpredictable is a broken product — even if it technically works.

Design the API before writing a single line of implementation. An API is a contract. Changing it after clients depend on it is expensive. Getting it right upfront is cheap.

---

## API Design Principles

- **Spec first, implement second.** Write the OpenAPI spec, GraphQL schema, or proto file before any implementation. The spec is the contract. Implementation details are irrelevant to the caller.
- **Consistency is the most important quality.** Every endpoint in an API should behave

via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有