mcpField
A
api-patterns

api-patterns

github.com/davila7开发33.0k486 次安装今天更新
代码仓库

关于 api-patterns

api-patterns 是面向开发者的 API 设计技能，帮助按具体需求选择 API 风格并制定方案。它以主题参考文件、决策清单和端点验证脚本组织内容。

主要功能

  1. 01REST、GraphQL 与 tRPC 选择指南
  2. 02REST 资源命名和 HTTP 方法指导
  3. 03响应、错误与分页模式
  4. 04版本控制、身份验证和速率限制
  5. 05OpenAPI 文档与安全测试
  6. 06端点验证脚本

适用场景

  1. 01为项目选择 API 风格
  2. 02规划统一响应格式与 API 版本
  3. 03选择身份验证和速率限制模式
  4. 04验证 API 端点

安装

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

$npx skills add https://github.com/davila7/claude-code-templates --skill api-patterns

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

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

api-style.md
auth.md
documentation.md
graphql.md
rate-limiting.md
response.md
rest.md
security-testing.md
trpc.md
versioning.md
scripts/
api_validator.py

详细介绍

API 模式

2025 年的 API 设计原则与决策方法。 学会思考，而不是照搬固定模式。

🎯 选择性阅读规则

只阅读与请求相关的文件！ 查看内容地图，找到你需要的内容。

📑 内容地图

文件描述何时阅读
api-style.mdREST 与 GraphQL 与 tRPC 决策树选择 API 类型时
rest.md资源命名、HTTP 方法、状态码设计 REST API 时
response.md信封模式、错误格式、分页响应结构
graphql.mdSchema 设计、何时使用、安全性考虑 GraphQL 时
trpc.mdTypeScript monorepo、类型安全TS 全栈项目
versioning.mdURI/Header/Query 版本控制API 演进规划
auth.mdJWT、OAuth、Passkey、API Keys认证模式选择
rate-limiting.md令牌桶、滑动窗口API 保护
documentation.mdOpenAPI/Swagger 最佳实践文档
security-testing.mdOWASP API Top 10、认证/授权测试安全审计

🔗 相关技能

需求技能
API 实现@[skills/backend-development]
数据结构@[skills/database-design]
安全细节@[skills/security-hardening]

✅ 决策清单

在设计 API 之前：

  • 询问过用户关于 API 消费者的情况吗？
  • 为当前场景选择了 API 风格吗？（REST/GraphQL/tRPC）
  • 定义了统一的响应格式吗？
  • 规划了版本控制策略吗？
  • 考虑过认证需求吗？
  • 规划了速率限制吗？
  • 定义了文档方案吗？

❌ 反模式

不要：

  • 默认对所有场景都使用 REST
  • 在 REST 端点中使用动词（/getUsers）
  • 返回不一致的响应格式
  • 向客户端暴露内部错误
  • 跳过速率限制

要：

  • 根据场景选择 API 风格
  • 询问客户端需求
  • 编写详尽文档
  • 使用适当的状态码

脚本

脚本用途命令
scripts/api_validator.pyAPI 端点验证python scripts/api_validator.py <project_path>

评论

支持 Markdown