BAIZE AI RESOURCE

claude-skills · api-designer｜REST/GraphQL API 架构设计专家

claude-skills · api-designer｜REST/GraphQL API 架构设计专家

面向 API 开发者的 Claude Code Skill，用于设计 REST/GraphQL API、整理 OpenAPI 3.1 契约，并规划版本、分页和错误处理。

获取资源
claude-skills · api-designer｜REST/GraphQL API 架构设计专家

资源介绍

api-designer 是 Jeffallan/claude-skills 中面向 Claude Code 的 API 设计 Skill。它按领域分析、资源建模、端点设计、OpenAPI 3.1 契约、mock 与演进规划的顺序协助 REST 和 GraphQL API 设计，并覆盖版本、分页、认证授权、错误响应、限流和请求/响应示例等设计要点。Redocly 与 Prism 为使用时另行提供的外部 CLI。

Skill 能力

REST 与 GraphQL 设计

为资源建模、端点、请求/响应模式和 API 演进提供设计指引。

OpenAPI 3.1 规范

工作流要求交付完整的 OpenAPI 3.1 规范，并提供请求/响应示例。

参考指南

仓库包含 REST 模式、版本、分页、错误处理和 OpenAPI 主题的参考文档。

契约验证建议

文档建议使用 Redocly CLI lint 规范、使用 Prism CLI mock；这些均为外部命令，需由使用环境另行提供。

设计约束

文档要求采用资源导向 URI、一致命名、RFC 7807 错误响应、分页、版本与弃用策略。

资源配置

适用平台

Claude Code

支持模型

Claude

调用方式

自动触发

安装与调用

  1. 1. 按上游仓库安装说明，将包含 api-designer 的技能包提供给 Claude Code。

  2. 2. 说明要设计的 REST 或 GraphQL API 的业务目标、数据模型和客户端需求。

  3. 3. 按技能工作流完成领域分析、资源与关系建模，再定义 URI、HTTP 方法和请求/响应结构。

  4. 4. 整理完整 OpenAPI 3.1 契约，并补充认证授权、错误响应、分页、版本与弃用策略。

  5. 5. 如需验证契约，在本机另行准备 Node.js 后使用 Redocly lint；如需 mock，再单独准备 Prism CLI。

使用案例

REST 用户管理 API

使用场景为新用户服务设计资源导向 REST 接口

完成用户资源、URI、HTTP 方法、请求/响应示例、分页和 RFC 7807 错误响应，再整理为 OpenAPI 3.1 契约。

GraphQL API 架构设计

使用场景为已有业务模型规划 GraphQL API

基于领域分析和资源关系梳理 schema 与操作边界，并同步制定认证授权、错误处理和演进策略。

OpenAPI 3.1 规范整理

使用场景将已有 API 设计沉淀为可交付契约

按技能输出清单补齐端点、数据结构、认证授权、错误响应、分页过滤、版本和弃用说明。

契约检查与 Mock 准备

使用场景在联调前核对 OpenAPI 定义

使用外部 Redocly CLI lint 检查规范；需要 mock 时另行使用外部 Prism CLI，二者均非该 Skill 内置工具。

包含内容

claude-skills-api-designer-source.zip
LICENSE-MIT.txt
README-中文安装说明.md
SHA256.txt

常见问题

api-designer 技能适用于哪些场景？
用于 REST 或 GraphQL API 设计、资源建模、端点与契约设计，以及版本、分页和错误处理策略。
如何安装和使用 api-designer？
请按 Jeffallan/claude-skills 上游仓库的安装说明，将技能包提供给 Claude Code；随后以 API 设计需求触发相应工作流。
api-designer 支持哪些模型或平台？
本次仅核实到上游仓库将其作为 Claude Code 技能提供；未核实其他 Agent 平台或模型系列的兼容性。
Redocly 和 Prism 是否由该 Skill 内置？
否。SKILL.md 仅建议在需要时使用这些外部 CLI lint 或 mock OpenAPI 契约；需由使用环境自行安装、审查并运行。
api-designer 的许可证是什么？
上游仓库根目录 LICENSE 为 MIT。MIT 允许使用、复制、修改、发布、再分发、再许可和销售，但副本或实质性部分必须保留版权与许可声明；外部 CLI/依赖可能另有许可证。