🗑️ 文件删除接口

功能概述

文件删除接口提供了三种删除方式：

• 业务类型路径删除：/delete/{业务类型}/{文件路径}
• 业务类型参数删除：/delete/{业务类型}?filePath=文件路径
• 默认删除：/delete?filePath=文件路径

删除流程

接口规格

1. 业务类型路径删除

推荐使用

此接口通过URL路径指定业务类型和文件路径，更加简洁直观。

接口信息

• 路径: /delete/{业务类型}/{文件路径}
• 方法: POST
• 说明: 通过URL路径指定业务类型和文件路径进行删除

请求参数

参数名	位置	类型	必填	说明	示例值
业务类型	Path	String	是	业务类型代码	demo
文件路径	Path	String	是	文件存储路径	2024/08/25/file.pdf

请求示例

POST /delete/demo/2024/08/25/23/891dc10b-9b8f-4d1a-bdcd-a298bcc6dc0b.pdf
Host: 127.0.0.1:9830

响应示例

删除成功

{
  "code": 0,
  "successful": true,
  "msg": null
}

删除失败

{
  "code": -1000,
  "successful": false,
  "msg": "文件删除失败"
}

2. 业务类型参数删除

接口说明

此接口通过查询参数指定文件路径，适合复杂路径场景。

接口信息

• 路径: /delete/{业务类型}
• 方法: POST
• 说明: 通过查询参数指定文件路径进行删除

请求参数

参数名	位置	类型	必填	说明	示例值
业务类型	Path	String	是	业务类型代码	demo
filePath	Query	String	是	文件存储路径	/2024/08/25/file.pdf

请求示例

POST /delete/demo?filePath=/2024/08/25/23/891dc10b-9b8f-4d1a-bdcd-a298bcc6dc0b.pdf
Host: 127.0.0.1:9830

3. 默认删除接口

安全提醒

默认删除接口不进行业务类型校验，建议在内网环境使用或增加额外的安全控制。

接口信息

• 路径: /delete
• 方法: POST
• 说明: 不区分业务类型的通用删除接口

请求参数

参数名	位置	类型	必填	说明	示例值
filePath	Query	String	是	文件存储路径	/2024/08/25/file.pdf

请求示例

POST /delete?filePath=/2024/08/25/23/891dc10b-9b8f-4d1a-bdcd-a298bcc6dc0b.pdf
Host: 127.0.0.1:9830

最佳实践

接口选择建议

1. 业务类型路径删除

   • 适用于标准的文件删除场景
   • URL更简洁，便于管理和审计
   • 推荐作为主要删除方式

2. 业务类型参数删除

   • 适用于文件路径包含特殊字符的场景
   • 适用于动态拼接文件路径的场景
   • 便于前端处理和参数拼接

3. 默认删除接口

   • 适用于内部系统或测试环境
   • 需要自行控制访问权限
   • 不建议在生产环境直接暴露

响应字段说明

字段名	类型	说明
code	Integer	错误码：0表示成功，其他值表示失败
successful	Boolean	操作是否成功：true-成功，false-失败
msg	String	错误信息：成功时为null，失败时包含具体错误描述