mcpField
D
discover-api

discover-api

github.com/rand开发190110 次安装35 周前更新
代码仓库

关于 discover-api

面向 Claude Code 的 API 技能发现入口，会在 API 相关工作时自动激活。它按需引导加载 REST、GraphQL、安全与生产运维等技能。

主要功能

  1. 01自动识别 API 相关任务
  2. 02涵盖 REST 与 GraphQL 设计
  3. 03提供认证与授权技能
  4. 04支持按需渐进加载
  5. 05推荐常见技能组合流程

适用场景

  1. 01规划新的 REST API
  2. 02设计 GraphQL 模式与解析器
  3. 03为 API 添加 OAuth 或权限控制
  4. 04完善限流、错误处理与版本管理

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/rand/cc-polymath --skill discover-api

安装后在 Claude Code 中输入/discover-api确认已加载。

详细介绍

API 技能发现

自动提供对全面的 API 设计、身份验证和实现技能的访问。

此技能的激活时机

在以下工作场景中，此技能会自动激活：

  • REST API 设计与实现
  • GraphQL 架构设计
  • API 身份验证（JWT、OAuth 2.0、API 密钥、会话）
  • API 授权（RBAC、ABAC、权限）
  • 速率限制与节流
  • API 版本控制策略
  • 错误处理与验证
  • HTTP 方法、状态码、端点

可用技能

快速参考

API 类别包含 8 项专用技能：

  1. rest-api-design - RESTful 资源建模、HTTP 语义、URL 约定
  2. graphql-schema-design - GraphQL 类型、解析器、N+1 问题防护
  3. api-authentication - JWT、OAuth 2.0、API 密钥、会话管理
  4. api-authorization - RBAC、ABAC、策略引擎、权限系统
  5. api-rate-limiting - 令牌桶、滑动窗口、速率限制算法
  6. api-versioning - API 版本控制、弃用、向后兼容
  7. api-error-handling - RFC 7807 错误、验证、标准化响应
  8. api-design-rules - 35 条针对 API 设计的主张明确的规则
加载完整类别详情

如需完整说明和工作流：

读取 ../api/INDEX.md

这会加载完整的 API 类别索引，其中包含：

  • 详细的技能说明
  • 每项技能的使用触发条件
  • 常见工作流组合
  • 相关技能的交叉引用
加载特定技能

按需加载单项技能：

核心 API 设计

读取 ../api/rest-api-design.md 读取 ../api/graphql-schema-design.md

安全与访问控制

读取 ../api/api-authentication.md 读取 ../api/api-authorization.md

生产环境加固

读取 ../api/api-rate-limiting.md 读取 ../api/api-error-handling.md 读取 ../api/api-versioning.md

规则与最佳实践

读取 ../api/api-design-rules.md

常见工作流

新建 REST API

顺序：REST 设计 → 身份验证 → 授权

读取 ../api/rest-api-design.md # 资源建模、HTTP 方法 读取 ../api/api-authentication.md # 用户身份验证 读取 ../api/api-authorization.md # 访问控制

新建 GraphQL API

顺序：GraphQL 架构 → 身份验证 → 授权

读取 ../api/graphql-schema-design.md # 架构设计、解析器 读取 ../api/api-authentication.md # 用户身份验证 读取 ../api/api-authorization.md # 字段级权限

API 加固

顺序：速率限制 → 错误处理 → 版本控制

读取 ../api/api-rate-limiting.md # 防止滥用 读取 ../api/api-error-handling.md # 标准化错误 读取 ../api/api-versioning.md # 管理演进

完整 API 技术栈

从头开始完整实现：

1. 设计阶段

读取 ../api/rest-api-design.md

2. 安全阶段

读取 ../api/api-authentication.md 读取 ../api/api-authorization.md 读取 ../api/api-rate-limiting.md

3. 生产就绪

读取 ../api/api-error-handling.md 读取 ../api/api-versioning.md

技能选择指南

在以下情况下选择 REST API 技能：

  • 构建传统 Web 服务
  • 需要简单的 CRUD 操作
  • 使用移动应用或 SPA
  • 需要缓存和 HTTP 语义

在以下情况下选择 GraphQL 技能：

  • 客户端需要灵活地获取数据
  • 减少过度获取或获取不足
  • 构建聚合层
  • 需要为 API 提供强类型

身份验证与授权：

  • 身份验证（api-authentication.md）：你是谁？（登录、JWT、OAuth）
  • 授权（api-authorization.md）：你可以做什么？（权限、RBAC）

生产环境注意事项：

  • 始终为公共 API 实施速率限制
  • 从第一天起就使用版本控制
  • 尽早统一错误响应

与其他技能集成

API 技能通常会与以下技能结合使用：

数据库技能（discover-database）：

  • API 端点 → 数据库查询
  • API 服务的连接池
  • 优化查询以提升 API 性能

测试技能（discover-testing）：

  • API 端点的集成测试
  • 面向 API 消费者的契约测试
  • API 性能的负载测试

前端技能（discover-frontend）：

  • API 客户端库
  • 数据获取模式
  • UI 中的错误处理

基础设施技能（discover-infra、discover-cloud）：

  • API 部署策略
  • 负载均衡与扩缩容
  • API 网关与代理

使用说明

  1. 自动激活：Claude Code 检测到 API 相关工作时，会自动加载此技能
  2. 浏览技能：运行 Read ../api/INDEX.md 查看完整的类别概览
  3. 加载特定技能：使用上面的 bash 命令加载单项技能
  4. 遵循工作流：针对常见 API 模式使用推荐的流程
  5. 组合技能：加载多项技能以全面覆盖

渐进式加载

此网关技能（约 200 行、约 2K 个令牌）支持渐进式加载：

  • 第 1 级：网关自动加载（你现在就在这里）
  • 第 2 级：加载类别 INDEX.md（约 3K 个令牌）以查看完整概览
  • 第 3 级：按需加载特定技能（每项约 2-3K 个令牌）

总上下文：2K + 3K + 技能 = 5-10K 个令牌；若加载整个索引则需 25K+ 个令牌。

快速入门示例

“为博客设计 REST API”： Read ../api/rest-api-design.md

“为我的 API 添加 OAuth 身份验证”： Read ../api/api-authentication.md

“实现基于角色的访问控制”： Read ../api/api-authorization.md

“防止 API 滥用”： Read ../api/api-rate-limiting.md

“设计 API 版本控制策略”： Read ../api/api-versioning.md

后续步骤：运行 Read ../api/INDEX.md 查看完整的类别详情，或使用上面的 bash 命令加载特定技能。

评论

支持 Markdown