通过Lambda与API Gateway从S3获取二进制图片失败的技术问询

I’ve gone through similar headaches serving binary images from Lambda via API Gateway, so let’s break down the key areas to check and fix step by step:

1. Ensure Lambda Returns a Proper Base64-Encoded Response #

First, confirm your Lambda function is generating valid Base64 and explicitly telling API Gateway to treat it as binary content—this is a critical, often overlooked detail.

• Mandatory flag: Set isBase64Encoded: true in your Lambda response. Without this, API Gateway will treat the Base64 string as plain text instead of decoding it to binary.
• Verify the image buffer is correctly converted to Base64. Here’s a trimmed example of a working handler (adjust for your AWS SDK version):

  const { S3Client, GetObjectCommand } = require("@aws-sdk/client-s3");
  const s3 = new S3Client({ region: "your-region" });
  
  exports.handler = async (event) => {
    try {
      const getObjParams = { Bucket: "your-s3-bucket", Key: "your-image-key" };
      const s3Response = await s3.send(new GetObjectCommand(getObjParams));
      const imageBuffer = await s3Response.Body.transformToByteArray();
      const base64Str = imageBuffer.toString("base64");
  
      // Optional: Log a snippet to validate later (copy this to a local decoder)
      console.log("Base64 preview:", base64Str.slice(0, 80));
  
      return {
        statusCode: 200,
        headers: {
          "Content-Type": "image/jpeg", // Match your image's actual MIME type (png, etc.)
          "Content-Encoding": "base64"
        },
        body: base64Str,
        isBase64Encoded: true // DO NOT FORGET THIS!
      };
    } catch (err) {
      console.error("Lambda error:", err);
      return { statusCode: 500, body: "Failed to retrieve image" };
    }
  };
  

• Test Lambda directly: Run a test in the Lambda console, then copy the body value and decode it locally (use a simple script or offline tool) to confirm it produces a valid image. If this fails, the issue lies with Lambda/S3 access, not API Gateway.

2. Fix API Gateway Binary Media Types Configuration #

API Gateway won’t automatically convert Base64 to binary unless you explicitly define which content types to treat as binary.

• Navigate to your API Gateway console → Select your API → Go to Settings → Find the Binary Media Types section.
• Add your image’s MIME type (e.g., image/jpeg, image/png). For testing, you can use */* to match all types, but stick to specific types in production.
• Critical: After updating this setting, re-deploy your API to a stage (existing or new). Changes won’t take effect until you deploy.

3. Validate Request/Response Headers #

Mismatched headers can cause API Gateway to fall back to text/plain instead of binary:

• In Postman/browser, ensure your request includes an Accept header that matches the Content-Type your Lambda returns (e.g., Accept: image/jpeg).
• Check API Gateway’s integration response settings: Make sure you’re not overwriting the Content-Type or Content-Encoding headers returned by Lambda. Leave these as "passthrough" unless you have a specific reason to modify them.
• Inspect response headers in Postman: If Content-Type shows up as text/plain or application/json, API Gateway isn’t recognizing the response as binary—double-check your Binary Media Types and Lambda’s isBase64Encoded flag.

4. Confirm S3 Permissions for Lambda #

If Lambda can’t read the S3 object, it’ll return invalid Base64 (or an error). Verify your Lambda execution role has the s3:GetObject permission for the target bucket and object:

• Go to IAM → Roles → Find your Lambda’s execution role → Check attached policies. You need a policy like this:

  {
    "Version": "2012-10-17",
    "Statement": [
      {
        "Effect": "Allow",
        "Action": "s3:GetObject",
        "Resource": "arn:aws:s3:::your-bucket-name/*"
      }
    ]
  }
  

Start with these checks—9 times out of 10, the issue is either missing isBase64Encoded in Lambda, incorrect Binary Media Types in API Gateway, or a forgotten deployment after changing settings.

内容的提问来源于stack exchange，提问作者Michael He