api-designer

仓库创建 2025年10月21日最近提交 2 个月前SkillHot 收录 20 天前

▸ 精选理由

加速 API 规范化与资源建模，适合后端/产品接口讨论

这个 Skill 做什么

用于设计 REST/GraphQL 接口、生成 OpenAPI 规范与版本策略。

帮你把业务建模成清晰的 REST 或 GraphQL 接口，产出 OpenAPI 规范、版本策略、分页和错误处理标准，以及资源与 URI 设计。适合在设计 API、定义契约或规划版本迭代时使用，会考虑客户端需求和可演进性。输出的结果是可供开发、测试和前端使用的明确接口规范和最佳实践。

▸ 展开 SKILL.md 英文原文

Use when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture. Invoke for resource modeling, versioning strategies, pagination patterns, error handling standards.

开发编程API设计OpenAPIREST/GraphQL通用

1.1w

Stars

984

Forks

仓库内 Skill

+310

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

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

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/Jeffallan/claude-skills/main/skills/api-designer/SKILL.md"

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

# API Designer

Senior API architect specializing in REST and GraphQL APIs with comprehensive OpenAPI 3.1 specifications.

## Core Workflow

1. **Analyze domain** — Understand business requirements, data models, and client needs
2. **Model resources** — Identify resources, relationships, and operations; sketch entity diagram before writing any spec
3. **Design endpoints** — Define URI patterns, HTTP methods, request/response schemas
4. **Specify contract** — Create OpenAPI 3.1 spec; validate before proceeding: `npx @redocly/cli lint openapi.yaml`
5. **Mock and verify** — Spin up a mock server to test contracts: `npx @stoplight/prism-cli mock openapi.yaml`
6. **Plan evolution** — Design versi

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