返回技能目录
人工审校软件开发

技能研究档案

api-designer

来源声明

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.

保留作者的英文原始描述。它表达设计意图,不代表已验证的实际效果。

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.

developmentreferences

研究摘要

人工审校

Skill Atlas editorial review · editorial-preview-1.0.0

引导设计 REST 或 GraphQL API:建模资源、定义端点、编写 OpenAPI 3.1 契约、校验并模拟,再规划版本策略。

审阅范围

对所收集的 SKILL.md 及辅助文本/代码进行确定性静态分析。机器辅助候选和发现等待人工编辑复核;不评估动态行为或效果。

可观察能力

  • 在写规范前先建模资源与关系,并绘制实体图。
  • 编写 OpenAPI 3.1 规范,并用 npx @redocly/cli lint 校验。
  • 使用 npx @stoplight/prism-cli mock 启动模拟服务来测试契约。
  • 设计 RFC 7807 错误响应、游标分页以及版本与弃用策略。

限制与范围

  • 产出的是设计与规范,而不是可运行的 API 实现。
  • 校验与模拟步骤依赖 npx 拉取 Redocly 和 Prism 包,需要网络与 Node.js。
  • 框架相关的指导交给相关 Skill,本 Skill 不涉及。

适用读者

  • 设计新 API 的后端与平台工程师
  • 希望统一错误格式与分页方式的团队
  • 评审 API 契约的人员

技能包含哪些内容

文件清单来自记录提交中的采集源码。路径与大小属于结构观察,不代表质量评价。

个文件
6
Markdown 文件
6
个脚本
0
个引用
5
大小
59.6 KB
结构复杂度
低

文件清单

路径类型字节
skills/api-designer/references/error-handling.md引用11.3 KB
skills/api-designer/references/openapi.md引用16 KB
skills/api-designer/references/pagination.md引用9.4 KB
skills/api-designer/references/rest-patterns.md引用7.3 KB
skills/api-designer/references/versioning.md引用7.8 KB
skills/api-designer/SKILL.md指令7.8 KB

SKILL.md 前置元数据

{
  "name": "api-designer",
  "description": "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.",
  "license": "MIT",
  "metadata": {
    "author": "https://github.com/Jeffallan",
    "company": "https://synergetic.solutions",
    "version": "1.1.0",
    "domain": "api-architecture",
    "triggers": "API design, REST API, OpenAPI, API specification, API architecture, resource modeling, API versioning, GraphQL schema, API documentation",
    "role": "architect",
    "scope": "design",
    "output-format": "specification",
    "related-skills": "graphql-architect, fastapi-expert, nestjs-expert, spring-boot-engineer, security-reviewer"
  }
}

对运行顺序的一种解读

此工作流根据源码材料重建表面顺序。除非明确记录受控评估,否则它属于暂定解读,而非真实运行轨迹。

  1. 01
    输入

    分析领域

    理解业务需求、数据模型和客户端需求。

  2. 02
    操作

    定义契约

    编写 OpenAPI 3.1 规范,并在继续前用 Redocly 校验。

  3. 03
    判断

    模拟并验证

    运行 Prism 模拟服务测试契约,再规划版本与弃用。

  4. 04
    输出

    交付设计包

    交付资源模型、端点规范、OpenAPI YAML、认证流程、错误目录和校验结果。

潜在风险面

静态发现用于提示安装前需要检查的位置,不能证明一项技能安全、恶意或有效。

有需要复核的项目

收集的文本中有 42 项确定性词法发现需要复核。发现可能仅位于文档中,不证明已执行或可被利用;仅含二进制的文件未扫描。

网络访问已观察到
文件写入已观察到
凭据使用未观察到
中

文本提及网络访问

28 次命中

此源文件行包含 URL 或网络客户端。应检查目标地址、发送的数据和信任边界;静态文本无法证明实际发生了网络活动。 该规则在收集文本中命中 28 处;此处列出 3 个代表位置。命中文本可能只是文档,分析器没有执行它。

提示

文本描述或实现了文件修改

14 次命中

此行包含可能的文件写入或重定向操作。应检查目标路径和覆盖行为;静态审查没有写入任何文件。 该规则在收集文本中命中 14 处;此处列出 3 个代表位置。命中文本可能只是文档,分析器没有执行它。

编辑安全提示

运行前检查它建议的 npx 命令,因为这些命令会下载并执行第三方包。

上下文可能消耗在哪里

发现、激活与资源层具有不同含义。只有使用指定官方方法并记录模型的运行时,才显示精确数值。

精确 token 计数不可用

在管线使用明确模型执行官方精确计数之前,包括文件清单在内的所有 token 值均为 null。

未使用要求的官方方法记录 token 测量。本档案不会用字符数、文件大小或估计值替代。

受控评估

没有受控评估

该技能仅具备以上标明的证据。不声称任何任务成功率、token 效率、延迟或质量优势。

尚未测试

在源码可见的情况下使用

安装命令
git clone https://github.com/Jeffallan/claude-skills.git cd claude-skills # 将该 Skill 目录复制到以下任一位置: # ~/.claude/skills/api-designer # .claude/skills/api-designer
  1. 打开固定版本源码:https://github.com/Jeffallan/claude-skills/blob/67c1961b180dc92cf08983344627109e983e8f51/skills/api-designer/SKILL.md。
  2. 审阅许可证、前置条件和所有捆绑的参考文件。
  3. 将 Skill 安装到个人或项目级 Claude Code skills 目录。
  4. 重启或刷新 Claude Code,使该 Skill 可被发现。
验证安装

确认目标位置存在 api-designer/SKILL.md,然后让 Claude Code 在一个小型测试任务中使用 api-designer Skill。

前置条件

  • 产出的是设计与规范,而不是可运行的 API 实现。
  • 校验与模拟步骤依赖 npx 拉取 Redocly 和 Prism 包,需要网络与 Node.js。
  • 框架相关的指导交给相关 Skill,本 Skill 不涉及。

示例提示词

代表性任务

Use the api-designer skill to design a REST API for an order-management service: model the resources, write an OpenAPI 3.1 spec with cursor pagination and RFC 7807 errors, and lint it.

使用前检查

Read the api-designer skill at https://github.com/Jeffallan/claude-skills/blob/67c1961b180dc92cf08983344627109e983e8f51/skills/api-designer/SKILL.md and its referenced files. Explain its workflow, required tools, permissions and the main risks before I decide whether to install it.

附上限制条件的判断

优势

  • 附带可直接复制的 OpenAPI 起始模板和 RFC 7807 错误示例。
  • 以要求校验零错误通过的检查清单收尾。

注意事项

  • 要求所有集合端点分页并制定版本策略,对内部原型可能偏重。
  • 模板中的默认值(如 Bearer JWT 认证)仅作示意,需要按实际调整。
研究结论

结构清晰的契约优先 API 设计流程,效果取决于你提供的领域信息。

从结构上保持可追溯

档案是对公开工件的限时阅读,而非背书。请通过来源链接检查确切的上游材料。

Jeffallanclaude-skillsskills/api-designer
来源类型
社区
提交
67c1961b180dc92cf08983344627109e983e8f51
采集时间
2026年11月20日
最近核查
2026年11月20日
上游许可证
MIT
仓库星标
12,464
内容依据

仅对提供的文件进行确定性词法解析、YAML frontmatter 校验、文件清单、来源描述的工作流程提取和启发式暂定分类。由机器生成;无 LLM、执行、动态测试或人工编辑批准。