使用API​​网关处理AWS Lambda错误

时间:2017-06-17 00:24:11

标签: python amazon-web-services aws-lambda aws-api-gateway aws-step-functions

我的Lambda函数中有class BadRequest(Exception): pass

我想raise BadRequest("Invalid request params")并让API返回状态代码为400且正文为{ "message": "Invalid request params" }(或等效)的响应。

然而,只需执行此操作即可返回状态代码为200(哦不!)和正文

的响应
{
    "errorMessage": "Invalid request params",
    "errorType": "BadRequest",
    "stackTrace": <my application code that the user shouldnt see>
}

在网上搜索后,似乎我有3种选择:

1)chalice

2)使用集成响应和方法响应将该错误解析为更好的响应。我会像[BadRequest].*一样使用正则表达式并在我抛出异常时插入一个前缀(不是非常优雅的IMO)。

3)使用Step Functions创建API的有状态表示。这看起来有点乏味,因为我需要学习ASL而且我不认识任何聋人。 -.-

-.- amazon states language

我应该去哪个兔洞?为什么?

4 个答案:

答案 0 :(得分:0)

Chalice使使用Lambda和API Gateway实施REST API非常简单,包括将引发的异常转换为响应。对于您的特殊情况,您将引发如下异常:

import chalice
app = chalice.Chalice(app_name='your-app')
app.debug = True  # Includes stack trace in response. Set to False for production.

@app.route('/api', methods=['GET'])
def your_api():
    raise chalice.BadRequestError("Your error message")

在GitHub上有一个完整的REST API工作示例,该示例使用带有Lambda的Chalice和API网关:aws-doc-sdk-examples

答案 1 :(得分:0)

三年后,我将回到这个问题来描述我今天如何解决这个问题。我使用Serverless Framework来部署我的lambda函数和一个API网关。

我使用一个装饰器来捕获异常并返回有效载荷。例如,这是一个成功的请求,一个预期的异常和一个意外的异常。

def my_successful_request(event, context):
    return {
        "statusCode": 200,
        "body": json.dumps({"success": True})
    }


def handle_exceptions(f):
    def deco(*args, **kwargs):
        try:
            return f(*args, **kwargs)
        except BadRequest as e:
            print(e)
            return {"statusCode": 400, "body": json.dumps({"message": str(e)})}
        except Exception as e:
            print(e)
            return {"statusCode": 500, "body": json.dumps({"message": "unexpected error"})}
    return deco

@handle_exceptions
def my_expected_error_request(event, context):
    raise BadRequest("This function raises a BadRequest with a 400 status code that should be sent to the user. The end user can read this text.")

@handle_exceptions
def my_unexpected_error_request(event, context):
    raise Exception("Uh oh. I didn't expect this. A 500 error with an obfuscated message is raised. The end user cannot read this text.")

此模式使API很容易返回适当的错误消息和status code。我在此handle_exceptions实现中具有非常基本的记录,但是您可以使用f.__name__获得非常详细的消息,以了解Lambda函数犯了什么错误,并可以通过traceback module了解异常的来源。所有这些错误管理对于API用户都是完全隐藏的。

答案 2 :(得分:-1)

你应该在Lambda中捕获异常并抛出自定义异常,如下所示。

public class LambdaFunctionHandler implements RequestHandler<String, String> {
  @Override
    public String handleRequest(String input, Context context) {

        Map<String, Object> errorPayload = new HashMap();
        errorPayload.put("errorType", "BadRequest");
        errorPayload.put("httpStatus", 400);
        errorPayload.put("requestId", context.getAwsRequestId());
        errorPayload.put("message", "Invalid request params " + stackstace);
        String message = new ObjectMapper().writeValueAsString(errorPayload);

        throw new RuntimeException(message);
    }
}

And then use Option 2  to map the error code .

Integration response:
Selection pattern: “.*"BadRequest".*”

Method response: 500

Mapping template:

#set ($errorMessageObj = $util.parseJson($input.path('$.errorMessage')))
{
  "type" : "$errorMessageObj.errorType",
  "message" : "$errorMessageObj.message",
  "request-id" : "$errorMessageObj.requestId"
}

答案 3 :(得分:-1)

这是AWS Step Functions的完美用例。您需要设置API网关以直接调用您将创建的状态机。

这是上述状态机的ASL:

{
  "Comment": "A state machine that executes my lambda function and catches the bad error.",
  "StartAt": "MyLambda",
  "States": {
    "MyLambda": {
      "Type": "Task",
      "Resource": "arn:aws:lambda:REGION:ACCOUNT_ID:function:FUNCTION_NAME",
      "Catch": [
        {
          "ErrorEquals": ["BadError"],
          "Next": "BadErrorFallback"
        }
      ],
      "End": true
    },
    "BadErrorFallback": {
      "Type": "Pass",
      "Result": "Put here whatever is the result that you want to return.",
      "End": true
    }
  }
}

这将是运行您提供的lambda函数。如果lambda函数抛出BadError,那么它将输出BadErrorFallback状态的结果。否则它将输出lambda函数吐出的任何内容。

希望这有帮助!