cursor-api-design

Cursor IDE 的 API 设计规则如下： 1. **一致性**：确保所有 API 端点遵循统一的命名规范、HTTP 方法和状态码使用方式。 2. **RESTful 风格**：优先采用 RESTful 架构，资源使用名词复数形式（如 `/users`），通过 HTTP 方法（GET、POST、PUT、DELETE）表达操作意图。 3. **版本控制**：在 URL 或请求头中明确标识 API 版本（如 `/v1/users`），便于后续迭代与兼容性管理。 4. **清晰的文档**：为每个 API 提供详细的接口说明，包括参数、请求示例、响应格式及错误码。 5. **安全性**：实施身份验证（如 JWT、OAuth）和权限控制，敏感数据需加密传输（HTTPS）。 6. **输入验证**：对所有输入参数进行严格校验，防止注入攻击和非法数据。 7. **错误处理**：返回结构化的错误信息，包含错误码、消息和可选的详细描述。 8. **分页与过滤**：对列表类接口支持分页（`page`, `limit`）和条件过滤（`filter`, `sort`）。 9. **速率限制**：设置合理的请求频率限制，保护系统资源。 10. **向后兼容**：尽量避免破坏性变更，如需修改应通过版本升级实现。

存档时间线

版本索引永久保留；内容副本只保留最新 1 份，更早版本仅留索引与哈希（存档时间线的证据链不会因此断裂）。

下载存档内容副本