Files
claude-howto/zh/02-memory/directory-api-CLAUDE.md
T
Luong NGUYEN b9a973bf32 docs: accuracy pass against Claude Code v2.1.220 (#155)
Internal accuracy pass against v2.1.220 — no missing upstream features, but broken example code, disagreeing counts, and metadata drift.

Functional fixes: pre-commit.sh now exits 2 so it actually blocks; dependency-check.sh reads file_path from stdin JSON instead of $1; database-mcp.json uses ${DATABASE_URL}; broken fences repaired; three command templates had invalid skill names.

Factual corrections: /fork and /subtask unswapped and /subtask added; /fewer-permission-prompts; permissions.defaultMode; dontAsk/auto unreversed; 31 hook events verified name-by-name; subagent depth 3; skill precedence enterprise > project > personal; /output-style removed not deprecated; permissionDecision gained defer.

Follow-up review fixed defects the pass left behind: zh/vi headers claiming 31 events above 25-name lists, a surviving hardcoded DB credential in the MCP README examples, an unbalanced fence swallowing a metadata footer, and non-canonical tool names. All four translated CATALOG summary tables were recounted so their arithmetic holds.

Full detail in CHANGELOG.md under v2.1.220-r2.
2026-08-04 15:41:12 +07:00

1.4 KiB

API 模块规范

本文件是对根目录 CLAUDE.md 的补充,作用于 /src/api/ 下的所有内容。memory 文件是拼接(concatenate)而不是覆盖 — 根目录 CLAUDE.md 依然生效,Claude Code 会在读取该子目录下的文件时按需加载本文件。

API 专属规范

请求校验

  • 使用 Zod 做 schema 校验
  • 始终校验输入
  • 校验失败时返回 400
  • 提供字段级别的错误详情

认证

  • 所有端点都需要 JWT token
  • token 放在 Authorization header 中
  • token 24 小时后过期
  • 实现 refresh token 机制

响应格式

所有响应都必须遵循下面的结构:

{
  "success": true,
  "data": { /* 实际数据 */ },
  "timestamp": "2025-11-06T10:30:00Z",
  "version": "1.0"
}

错误响应:

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "用户可读消息",
    "details": { /* 字段错误 */ }
  },
  "timestamp": "2025-11-06T10:30:00Z"
}

分页

  • 使用基于 cursor 的分页,而不是 offset
  • 包含 hasMore 布尔值
  • 单页最大数量限制为 100
  • 默认页大小:20

限流

  • 已认证用户每小时 1000 次请求
  • 公开端点每小时 100 次请求
  • 超出时返回 429
  • 包含 retry-after header

缓存

  • 使用 Redis 做会话缓存
  • 缓存时长默认 5 分钟
  • 写操作时失效缓存
  • 用资源类型给缓存键打标签