TandoorRecipes API 图片上传问题排查与解决方案

问题背景

在使用TandoorRecipes的API进行图片上传时，开发者可能会遇到一个看似成功但实际上未生效的情况。具体表现为：通过PUT请求向/api/recipe/{id}/image/端点上传图片时，API返回200状态码，但响应体中image和image_url字段均为null，且图片并未实际保存到系统中。

问题现象

开发者尝试了多种方式上传图片，包括：

1. 使用curl命令直接上传webp格式图片
2. 使用JavaScript的FormData方式上传
3. 使用Java的WebClient进行多部分表单提交

所有方法都返回相同的响应：

{"image":null,"image_url":null}

关键发现

经过深入排查，发现问题根源在于表单字段名称的使用不当。TandoorRecipes API对于食谱图片上传端点有特定的字段名要求：

• 错误方式：使用file作为字段名
• 正确方式：必须使用image作为字段名

解决方案

Java实现示例

以下是经过验证可用的Java实现代码：

// 从URL加载图片
BufferedImage image = ImageIO.read(new URL(imagePath));

// 将图片转换为字节数组
ByteArrayOutputStream baos = new ByteArrayOutputStream();
ImageIO.write(image, "jpg", baos);
byte[] imageBytes = baos.toByteArray();
baos.close();

// 准备图片资源
ByteArrayResource imageResource = new ByteArrayResource(imageBytes) {
    @Override
    public String getFilename() {
        return imagePath;
    }
};

// 准备多部分表单数据
MultiValueMap<String, Object> formData = new LinkedMultiValueMap<>();
formData.add("image", imageResource);  // 关键：必须使用"image"作为字段名
formData.add("image_url", imagePath);

// 发送请求
return webClient
        .put()
        .uri("/api/recipe/{id}/image/", recipeId)
        .headers(h -> h.setBearerAuth(apiToken))
        .contentType(MediaType.MULTIPART_FORM_DATA)
        .body(BodyInserters.fromMultipartData(formData))
        .retrieve()
        .toEntity(ImageResponse.class)
        .block()
        .getBody();

Python实现示例

对于Python开发者，可以使用以下代码：

headers = {
    'Authorization': 'Bearer your_api_token',
    'Content-Type': None  # 将由MultipartEncoder自动设置
}

# 准备多部分表单数据
m = MultipartEncoder(
    fields={
        'image': ('filename.jpg', image_data, 'image/jpeg')  # 关键：使用'image'作为字段名
    }
)
headers['Content-Type'] = m.content_type

response = requests.put(
    f'/api/recipe/{recipe_id}/image/',
    data=m,
    headers=headers
)

技术要点

1. 字段名要求：TandoorRecipes API对不同的上传端点有不同的字段名要求：

   • 用户文件上传端点(/api/user-file/)使用file字段
   • 食谱图片上传端点(/api/recipe/{id}/image/)使用image字段

2. 内容类型：必须正确设置Content-Type头部，通常由多部分表单编码器自动处理

3. 响应处理：成功上传后，API应返回包含图片信息的响应，如：

   {
       "image": "图片标识符",
       "image_url": "图片访问URL"
   }
   

总结

在使用TandoorRecipes API进行图片上传时，开发者需要特别注意不同端点对表单字段名的不同要求。对于食谱图片上传，必须使用image作为字段名而非通用的file。这一细节差异可能导致看似成功但实际上失败的操作。理解API设计的这一特点，可以避免在集成过程中遇到类似问题。