api-design

仓库创建 2026年6月30日最近提交 22 天前SkillHot 收录 22 天前

▸ 精选理由

在实现前明确契约与破坏性变更，减少后续返工。

这个 Skill 做什么

从需求与数据模型生成版本化、安全的 API 合约（REST/GraphQL/RPC/事件/SDK）。

从需求和数据模型出发把接口合约定清楚：资源、版本控制、错误码、分页和安全策略都写好，生成 REST/GraphQL/RPC/event/SDK 等可实施的 contract。通常在实现端点之前或准备做破坏性变更时用。特点是把契约版本化并防止误用，方便前后端和第三方按约同步演进。

▸ 展开 SKILL.md 英文原文

Design versioned, secure API contracts (REST, GraphQL, RPC, events, SDK surface) from requirements and data model. Use before implementing endpoints or for a breaking contract change.

开发编程API设计版本与兼容REST/GraphQL通用

Stars

Forks

仓库内 Skill

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/muxammadmamajonov/dot-claude/main/.claude/skills/api-design/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/muxammadmamajonov/dot-claude/main/.claude/skills/api-design/SKILL.md"

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

# API Design

**Scope: the API CONTRACT (resources, versioning, errors, pagination). Implementation → `.claude/skills/backend/SKILL.md`.**

## When to use
- After requirements (`.claude/skills/requirements-engineering/SKILL.md`) and data modeling (`.claude/skills/data-modeling/SKILL.md`), before endpoint/handler implementation.
- When defining any boundary contract: public/partner API, internal service-to-service, event/message schema, CLI surface, or a library/SDK's public interface.
- When a contract must change in a backward-incompatible way and consumers must be migrated safely.

## Workflow
1. **Pick the interface style** to match consumers and the architecture (`docs/architecture/overv

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