在AWS API Gateway JavaScript SDK中设置路径参数

Mas*_*son 9 amazon-web-services aws-api-gateway

我正在尝试通过JavaScript SDK调用API Gateway端点时设置路径参数,但没有任何运气.看起来我要么配置错误,要么SDK生成中存在错误.

我能够成功调用不采用路径参数的端点,但是当我尝试传入一个参数用作路径参数时,SDK只用空格替换路径参数,我的调用失败.

例如,假设client是一个正确初始化的API网关客户端.我有一个叫做/measurement孩子的端点/measurement/{id}.我可以直接打电话.

client.measurementGet({},{});- 成功调用我的/measurement终端 client.measurementIdGet({"id": "1234"}, {});- 浏览器拨打电话/measurement/而不是/measurement/1234

查看我的apigClient.js的来源,看来SDK生成器没有将路径参数放入它正在寻找的参数列表中.例如,我生成的measurementIdGet方法的代码如下所示:

    apigClient.measurementIdGet = function (params, body, additionalParams) {
        if(additionalParams === undefined) { additionalParams = {}; }

        apiGateway.core.utils.assertParametersDefined(params, [], ['body']);

        var measurementIdGetRequest = {
            verb: 'get'.toUpperCase(),
            path: pathComponent + uritemplate('/measurement/{id}').expand(apiGateway.core.utils.parseParametersToObject(params, [])),
            headers: apiGateway.core.utils.parseParametersToObject(params, []),
            queryParams: apiGateway.core.utils.parseParametersToObject(params, []),
            body: body
        };

        return apiGatewayClient.makeRequest(measurementIdGetRequest, authType, additionalParams, config.apiKey);
    };
Run Code Online (Sandbox Code Playgroud)

我挖到了assertParametersDefined和parseParametersToObject看起来这些方法看起来正在寻找一个参数列表.在这两种情况下,SDK都生成了空列表,而不是将路径参数放在那里.

如果我手动更新生成的文件以将两行更改为

apiGateway.core.utils.assertParametersDefined(params, ['id'], ['body']);

和

apiGateway.core.utils.parseParametersToObject(params, ['id'])

SDK会拨打正确的电话.

我在配置中遗漏了什么或者代码生成器中是否有错误?

Jon*_*ner 0

假设您要导入 swagger 定义来创建 API,那么parameters在方法级别(而不是路径级别)定义您的 API 将生成一个已填写的 SDK key,并且应该可以正常工作。

{
    ...
    "/path/{to}/resource": {
        "get": {
            "parameters": [ // define here
                "name": "to",
                "in": "path",
                ...
            ],
            ...
        },
        "parameters": [] // not here
}
Run Code Online (Sandbox Code Playgroud)

尽管parameters根据 Swagger 规范,在路径级别进行定义是正确的,并且 API Gateway 确实在创建的 API 中使用它们,但 API Gateway 在某些上下文中似乎忽略了它们。