api-design-safety
当设计或修改 REST API 响应结构、处理 API 返回值时触发。防止 API 设计缺陷导致的字段错位、类型歧义等问题。
当使用 MinIO/OSS/S3 等对象存储、设计文件上传下载功能时触发。提供存储 URL 策略选择规范,防止 URL 过期、访问失败等问题。
Claude Code
$ npx -y skills add doccker/cc-use-exp --skill storage-url-safety --agent claude-code
Codex
$ npx skills add doccker/cc-use-exp --skill storage-url-safety -a codex -y
Cursor
$ npx skills add doccker/cc-use-exp --skill storage-url-safety -a cursor -y
Gemini CLI
$ npx skills add doccker/cc-use-exp --skill storage-url-safety -a gemini-cli -y
GitHub Copilot
$ npx skills add doccker/cc-use-exp --skill storage-url-safety -a github-copilot -y
OpenCode
$ npx skills add doccker/cc-use-exp --skill storage-url-safety -a opencode -y
Windsurf
$ npx skills add doccker/cc-use-exp --skill storage-url-safety -a windsurf -y
name: storage-url-safety description: 当使用 MinIO/OSS/S3 等对象存储、设计文件上传下载功能时触发。提供存储 URL 策略选择规范,防止 URL 过期、访问失败等问题。
当使用 MinIO/OSS/S3 等对象存储时,正确选择 URL 生成策略。
---
**场景**: 头像、Logo、商品图等需要长期访问的资源
预签名 URL 有时效限制(MinIO/S3 最大 7 天),头像等长期资源会过期导致无法访问。
// ❌ 错误: 预签名 URL 最大 7 天,头像会过期 String avatarUrl = minioService.getPresignedUrl(filePath, 60 * 24 * 365); // IllegalArgumentException: expiry must be minimum 1 second to maximum 7 days // ❌ 错误: 即使设置 7 天,头像也会在 7 天后失效 String avatarUrl = minioService.getPresignedUrl(filePath, 60 * 24 * 7); // 7 天后用户头像显示"图片加载失败"
// ✅ 方案1: 公开 URL(需配置 bucket 公开读)
public String getPublicUrl(String filePath) {
String endpoint = minioConfig.getEndpoint();
if (endpoint.endsWith("/")) {
endpoint = endpoint.substring(0, endpoint.length() - 1);
}
return endpoint + "/" + minioConfig.getBucketName() + "/" + filePath;
}
String avatarUrl = minioService.getPublicUrl(filePath);
// 返回: http://minio:9000/bucket/avatars/xxx.jpeg
// ✅ 方案2: CDN URL(生产环境推荐)
String avatarUrl = cdnService.getCdnUrl(filePath);
// 返回: https://cdn.example.com/avatars/xxx.jpeg---
| 资源类型 | 推荐策略 | 有效期 | 适用场景 | 示例 | |---------|---------|-------|---------|------| | 头像/Logo | 公开 URL / CDN | 永久 | 需长期访问 | 用户头像、企业 Logo | | 商品图片 | 公开 URL / CDN | 永久 | 需长期访问 | 电商商品图、文章配图 | | 公开文档 | 公开 URL / CDN | 永久 | 需长期访问 | 用户手册、API 文档 | | 临时文件 | 预签名 URL | 1h-7d | 下载凭证 | 导出的 Excel、临时分享 | | 私密文档 | 预签名 URL | 15min-1h | 临时授权 | 合同、财务报表 | | 上传凭证 | 预签名 URL | 5min-30min | 客户端直传 | 前端直传 OSS |
---
**场景**: 使用公开 URL 但 bucket 策略未配置
// ✅ 代码正确生成公开 URL String avatarUrl = minioService.getPublicUrl(filePath); // 返回: http://minio:9000/bucket/avatars/xxx.jpeg // ❌ 但 bucket 未配置公开读,访问返回 403 Forbidden
**MinIO 配置公开读**:
# 方案1: 使用 mc 命令配置(推荐) mc anonymous set download minio/bucket/avatars # 方案2: 使用 bucket policy mc admin policy attach minio readonly --user=public
**Bucket Policy 示例**:
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {"AWS": ["*"]},
"Action": ["s3:GetObject"],
"Resource": ["arn:aws:s3:::bucket/avatars/*"]
}
]
}**阿里云 OSS 配置**:
# 设置 bucket 公共读 ossutil64 set-acl oss://bucket-name public-read # 或只设置特定目录 ossutil64 set-acl oss://bucket-name/avatars/ public-read --recursive
---
**场景**: 临时文件下载链接有效期过长或过短
| 场景 | 推荐有效期 | 说明 | |------|-----------|------| | 客户端直传凭证 | 5-30 分钟 | 上传时间通常很短 | | 临时分享链接 | 1-24 小时 | 用户可能稍后下载 | | 导出文件下载 | 1-7 天 | 用户可能多次下载 | | 私密文档查看 | 15-60 分钟 | 安全性要求高 |
// ❌ 错误: 客户端直传凭证有效期 7 天,安全风险高 String uploadUrl = minioService.getPresignedUrl(filePath, 60 * 24 * 7); // ❌ 错误: 导出文件下载链接只有 5 分钟,用户可能来不及下载 String downloadUrl = minioService.getPresignedUrl(filePath, 5);
// ✅ 客户端直传凭证: 15 分钟 String uploadUrl = minioService.getPresignedUrl(filePath, 15); // ✅ 导出文件下载: 24 小时 String downloadUrl = minioService.getPresignedUrl(filePath, 60 * 24); // ✅ 私密文档查看: 30 分钟 String viewUrl = minioService.getPresignedUrl(filePath, 30);
---
**场景**: 前端直传 OSS,后端生成上传凭证
// ❌ 错误: 未校验文件类型和大小,任何文件都能上传
@PostMapping("/upload/token")
public ApiResponse<String> getUploadToken(@RequestParam String filename) {
String uploadUrl = minioService.getPresignedUrl("uploads/" + filename, 15);
return ApiResponse.success(uploadUrl);
}// ✅ 后端校验文件类型和大小
@PostMapping("/upload/token")
public ApiResponse<UploadToken> getUploadToken(
@RequestParam String filename,
@RequestParam String contentType,
@RequestParam Long fileSize) {
// 校验文件类型
List<String> allowedTypes = Arrays.asList("image/jpeg", "image/png", "image/gif");
if (!allowedTypes.contains(contentType)) {
return ApiResponse.error("不支持的文件类型");
}
// 校验文件大小(5MB)
if (fileSize > 5 * 1024 * 1024) {
return ApiResponse.error("文件大小不能超过 5MB");
}
// 生成安全的文件名(防止路径遍历)
String safeFilename = UUID.randomUUID() + getExtension(filename);
String filePath = "avatars/" + LocalDate.now() + "/" + safeFilename;
String uploadUrl = minioService.getPresignedUrl(filePath, 15);
return ApiResponse.success(new UploadToken(uploadUrl, filePath));
}---
**场景**: 使用 CDN 加速但回源配置不正确
// ✅ 代码正确返回 CDN URL String avatarUrl = "https://cdn.example.com/avatars/xxx.jpeg"; // ❌ 但 CDN 回源配置错误: // 1. 回源 Host 未设置为 MinIO endpoint // 2. 回源协议未设置为 HTTP // 3. 回源路径未包含 bucket 名称 // 导致 CDN 返回 404 或 403
**阿里云 CDN 回源配置**:
回源 Host: minio.example.com
回源协议: HTTP
回源地址: minio.example.com:9000
回源路径: /bucket${uri}**腾讯云 CDN 回源配置**:
源站类型: 自有源
源站地址: minio.example.com:9000
回源协议: HTTP
回源 Host: minio.example.com
回源路径: /bucket${uri}---
**URL 策略选择**:
**Bucket 配置**:
**CDN 配置**:
**安全性**:
---
---
> 📋 本回复遵循:`storage-url-safety` - 存储 URL 策略选择规范
保留你熟悉的 CLI/IDE,让 Claude Code、Gemini CLI、Codex、Cursor、GitHub Copilot 开箱即用 按费力度从低到高,用最少操作获得最大帮助 不是提示词集合,而是一套可维护的 AI 协作配置系统。
当设计或修改 REST API 响应结构、处理 API 返回值时触发。防止 API 设计缺陷导致的字段错位、类型歧义等问题。
网关/代理/WAF/CDN 中间件的安全关键词匹配实现规范,防止纯子串匹配误判正常响应内容中的技术术语(如 Cloudflare、502、error)
当 API/任务可能执行超过 10 秒(批量数据处理、远程 API 批量调用、全表扫描、跨租户聚合)时触发。防止同步接口被网关 30s 超时切断、用户重复点击触发并发、状态缓存内存泄漏等问题。提供异步任务状态机标准模板。
当用户操作 .sh、Dockerfile、Makefile、.yml、.yaml 文件,或在 Markdown 中编写 bash 代码块时触发。提供 Bash 编写规范。
当编写新模块、设计接口、重构代码或代码审查时触发。提供经典模块化六原则检查清单(大小适中/调用深度/扇入扇出/边界清晰/作用域内聚/可预测性),适用于 PR/Review/新模块设计场景。
涉及浏览器、编辑器、CDN/WAF、IM 平台、操作系统剪贴板、第三方 SaaS 等"外部黑盒系统"的代码编写或 bug 调试时触发。强制先抓真实环境数据再推理,避免连续 2 轮"凭代码推理"的修复…
You MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or…
Ask which skill or flow fits your situation. A router over the skills in this repo.