教程：使用 AWS SDK 或 AWS CLI 创建 REST API

使用 AWS SDK 设置边缘优化的 PetStore API

1. 使用以下示例来创建 RestApi 实体：

   JavaScript v3

   import {APIGatewayClient, CreateRestApiCommand} from "@aws-sdk/client-api-gateway";
   (async function (){
   const apig = new APIGatewayClient({region:"us-east-1"});
   const command = new CreateRestApiCommand({
       name: "Simple PetStore (JavaScript v3 SDK)",
       description: "Demo API created using the AWS SDK for JavaScript v3",
       version: "0.00.001",
       binaryMediaTypes: [
       '*']
   });
   try {
       const results = await apig.send(command)
       console.log(results)
   } catch (err) {
       console.error(Couldn't create API:\n", err)
   }
   })();

   成功的调用会在输出中返回 API ID 和 API 的根资源 ID，如下所示：

   {
     id: 'abc1234',
     name: 'PetStore (JavaScript v3 SDK)',
     description: 'Demo API created using the AWS SDK for node.js',
     createdDate: 2017-09-05T19:32:35.000Z,
     version: '0.00.001',
     rootResourceId: 'efg567'
     binaryMediaTypes: [ '*' ] 
   }

   Python

   import botocore
   import boto3
   import logging
   
   logger = logging.getLogger()
   apig = boto3.client('apigateway')
   
   try:
       result = apig.create_rest_api(
           name='Simple PetStore (Python SDK)',
           description='Demo API created using the AWS SDK for Python',
           version='0.00.001',
           binaryMediaTypes=[
               '*'
           ]
       )
   except botocore.exceptions.ClientError as error:
       logger.exception("Couldn't create REST API %s.", error)
       raise
   attribute=["id","name","description","createdDate","version","binaryMediaTypes","apiKeySource","endpointConfiguration","disableExecuteApiEndpoint","rootResourceId"]
   filtered_result ={key:result[key] for key in attribute}
   print(filtered_result)

   成功的调用会在输出中返回 API ID 和 API 的根资源 ID，如下所示：

   {'id': 'abc1234', 'name': 'Simple PetStore (Python SDK)', 'description': 'Demo API created using the AWS SDK for Python', 'createdDate': datetime.datetime(2024, 4, 3, 14, 31, 39, tzinfo=tzlocal()), 'version': '0.00.001', 'binaryMediaTypes': ['*'], 'apiKeySource': 'HEADER', 'endpointConfiguration': {'types': ['EDGE']}, 'disableExecuteApiEndpoint': False, 'rootResourceId': 'efg567'}

   AWS CLI

   aws apigateway create-rest-api --name 'Simple PetStore (AWS CLI)' --region us-west-2

   此命令的输出如下：

   {
       "id": "abcd1234", 
       "name": "Simple PetStore (AWS CLI)", 
       "createdDate": "2022-12-15T08:07:04-08:00",
       "apiKeySource": "HEADER",
       "endpointConfiguration": {
           "types": [
               "EDGE"
           ]
       },
       "disableExecuteApiEndpoint": false,
       "rootResourceId": "efg567"
   }

   您创建的 API 的 API ID 为 abcd1234，根资源 ID 为 efg567。您可以在 API 的设置中使用这些值。

2. 接下来，在根目录下附加子资源，您可以将 RootResourceId 指定为 parentId 属性值。使用以下示例为 API 创建 /pets 资源：

   JavaScript v3

   import {APIGatewayClient,  CreateResourceCommand } from "@aws-sdk/client-api-gateway";
   (async function (){
   const apig = new APIGatewayClient({region:"us-east-1"});
   const command = new CreateResourceCommand({
       restApiId: 'abcd1234',
       parentId: 'efg567',
       pathPart: 'pets'
   });
   try {
       const results = await apig.send(command)
       console.log(results)
   } catch (err) {
       console.log("The '/pets' resource setup failed:\n", err)
   }
   })();

   成功的调用会在输出中返回有关您的资源的信息，如下所示：

   {
       "path": "/pets", 
       "pathPart": "pets", 
       "id": "aaa111", 
       "parentId": "efg567'"
   }

   Python

   import botocore
   import boto3
   import logging
   
   logger = logging.getLogger()
   apig = boto3.client('apigateway')
   
   try:
       result = apig.create_resource(
           restApiId='abcd1234',
           parentId='efg567',
           pathPart='pets'
       )
   except botocore.exceptions.ClientError as error:
       logger.exception("The '/pets' resource setup failed: %s.", error)
       raise
   attribute=["id","parentId", "pathPart", "path",]
   filtered_result ={key:result[key] for key in attribute}
   print(filtered_result)

   成功的调用会在输出中返回有关您的资源的信息，如下所示：

   {'id': 'aaa111', 'parentId': 'efg567', 'pathPart': 'pets', 'path': '/pets'}

   AWS CLI

   aws apigateway create-resource --rest-api-id abcd1234 \
     --region us-west-2 \
     --parent-id efg567 \
     --path-part pets

   此命令的输出如下：

   {
       "id": "aaa111", 
       "parentId": "efg567",
       "pathPart": "pets",
       "path": "/pets"
   }

   您创建的 /pets 资源的资源 ID 为 aaa111。您可以在 API 的设置中使用此值。

3. 接下来，在 /pets 资源下附加子资源。此资源 /{petId} 具有 {petId} 的路径参数。为了让路径部分成为路径参数，请将其括在一对大括号 { } 内。使用以下示例为 API 创建 /pets/{petId} 资源：

   JavaScript v3

   import {APIGatewayClient,  CreateResourceCommand } from "@aws-sdk/client-api-gateway";
   (async function (){
   const apig = new APIGatewayClient({region:"us-east-1"});
   const command = new CreateResourceCommand({
       restApiId: 'abcd1234',
       parentId: 'aaa111',
       pathPart: '{petId}'
   });
   try {
       const results = await apig.send(command)
       console.log(results)
   } catch (err) {
       console.log("The '/pets/{petId}' resource setup failed:\n", err)
   }
   })();

   成功的调用会在输出中返回有关您的资源的信息，如下所示：

   {
       "path": "/pets/{petId}", 
       "pathPart": "{petId}", 
       "id": "bbb222", 
       "parentId": "aaa111'"
   }

   Python

   import botocore
   import boto3
   import logging
   
   logger = logging.getLogger()
   apig = boto3.client('apigateway')
   
   try:
       result = apig.create_resource(
           restApiId='abcd1234',
           parentId='aaa111',
           pathPart='{petId}'
       )
   except botocore.exceptions.ClientError as error:
       logger.exception("The '/pets/{petId}' resource setup failed: %s.", error)
       raise
   attribute=["id","parentId", "pathPart", "path",]
   filtered_result ={key:result[key] for key in attribute}
   print(filtered_result)

   成功的调用会在输出中返回有关您的资源的信息，如下所示：

   {'id': 'bbb222', 'parentId': 'aaa111', 'pathPart': '{petId}', 'path': '/pets/{petId}'}

   AWS CLI

   aws apigateway create-resource --rest-api-id abcd1234 \
     --region us-west-2 \
     --parent-id aaa111 \
     --path-part '{petId}'

   如果成功，该命令会返回以下响应：

   {
       "id": "bbb222",
       "parentId": "aaa111",
       "path": "/pets/{petId}", 
       "pathPart": "{petId}"
   }

   您创建的 /pets/{petId} 资源的资源 ID 为 bbb222。您可以在 API 的设置中使用此值。

4. 在以下两个步骤中，您向资源添加 HTTP 方法。在本教程中，您可以通过将 authorization-type 设置为 NONE，来将方法设置为具有开放访问权限。要仅允许已验证身份的用户调用此方法，您可以使用 IAM 角色和策略、Lambda 授权方（以前称为自定义授权方）或者 Amazon Cognito 用户池。有关更多信息，请参阅 在 API Gateway 中控制和管理对 REST API 的访问。

   以下示例在 /pets 资源上添加 GET HTTP 方法：

   JavaScript v3

   import {APIGatewayClient,  PutMethodCommand } from "@aws-sdk/client-api-gateway";
   (async function (){
   const apig = new APIGatewayClient({region:"us-east-1"});
   const command = new PutMethodCommand({
       restApiId: 'abcd1234',
       resourceId: 'aaa111',
       httpMethod: 'GET',
       authorizationType: 'NONE'
   });
   try {
       const results = await apig.send(command)
       console.log(results)
   } catch (err) {
       console.log("The 'GET /pets' method setup failed:\n", err)
   }
   })();

   成功的调用返回以下输出：

   {
       "apiKeyRequired": false, 
       "httpMethod": "GET", 
       "authorizationType": "NONE"
   }

   Python

   import botocore
   import boto3
   import logging
   
   logger = logging.getLogger()
   apig = boto3.client('apigateway')
   
   try:
       result = apig.put_method(
           restApiId='abcd1234',
           resourceId='aaa111',
           httpMethod='GET',
           authorizationType='NONE'
       )
   except botocore.exceptions.ClientError as error:
       logger.exception("The 'GET /pets' method setup failed: %s", error)
       raise
   attribute=["httpMethod","authorizationType","apiKeyRequired"]
   filtered_result ={key:result[key] for key in attribute}
   print(filtered_result)

   成功的调用返回以下输出：

   {'httpMethod': 'GET', 'authorizationType': 'NONE', 'apiKeyRequired': False}

   AWS CLI

   aws apigateway put-method --rest-api-id abcd1234 \
     --resource-id aaa111 \
     --http-method GET \
     --authorization-type "NONE" \
     --region us-west-2

   此命令的成功输出如下：

   {
       "httpMethod": "GET", 
       "authorizationType": "NONE",
       "apiKeyRequired": false
   }

5. 以下示例在 /pets/{petId} 资源上添加 GET HTTP 方法，并设置 requestParameters 属性来将客户端提供的 petId 值传递给后端：

   JavaScript v3

   import {APIGatewayClient,  PutMethodCommand } from "@aws-sdk/client-api-gateway";
   (async function (){
   const apig = new APIGatewayClient({region:"us-east-1"});
   const command = new PutMethodCommand({
       restApiId: 'abcd1234',
       resourceId: 'bbb222',
       httpMethod: 'GET',
       authorizationType: 'NONE'
       requestParameters: {
           "method.request.path.petId" : true
       }
   });
   try {
       const results = await apig.send(command)
       console.log(results)
   } catch (err) {
       console.log("The 'GET /pets/{petId}' method setup failed:\n", err)
   }
   })();

   成功的调用返回以下输出：

   {
       "apiKeyRequired": false, 
       "httpMethod": "GET", 
       "authorizationType": "NONE",
       "requestParameters": {
          "method.request.path.petId": true
       }
   }

   Python

   import botocore
   import boto3
   import logging
   
   logger = logging.getLogger()
   apig = boto3.client('apigateway')
   
   try:
       result = apig.put_method(
           restApiId='abcd1234',
           resourceId='bbb222',
           httpMethod='GET',
           authorizationType='NONE',
           requestParameters={
               "method.request.path.petId": True
           }
       )
   except botocore.exceptions.ClientError as error:
       logger.exception("The 'GET /pets/{petId}' method setup failed: %s", error)
       raise
   attribute=["httpMethod","authorizationType","apiKeyRequired", "requestParameters" ]
   filtered_result ={key:result[key] for key in attribute}
   print(filtered_result)

   成功的调用返回以下输出：

   {'httpMethod': 'GET', 'authorizationType': 'NONE', 'apiKeyRequired': False, 'requestParameters': {'method.request.path.petId': True}}

   AWS CLI

   aws apigateway put-method --rest-api-id abcd1234 \
     --resource-id bbb222 --http-method GET \
     --authorization-type "NONE" \
     --region us-west-2 \
     --request-parameters method.request.path.petId=true

   此命令的成功输出如下：

   {
       "httpMethod": "GET", 
       "authorizationType": "NONE", 
       "apiKeyRequired": false, 
       "requestParameters": {
           "method.request.path.petId": true
       }
   }

6. 使用以下示例为 GET /pets 方法添加 200 OK 方法响应：

   JavaScript v3

   import {APIGatewayClient,  PutMethodResponseCommand } from "@aws-sdk/client-api-gateway";
   (async function (){
   const apig = new APIGatewayClient({region:"us-east-1"});
   const command = new PutMethodResponseCommand({
       restApiId: 'abcd1234',
       resourceId: 'aaa111',
       httpMethod: 'GET',
       statusCode: '200'
   });
   try {
       const results = await apig.send(command)
       console.log(results)
   } catch (err) {
       console.log("Set up the 200 OK response for the 'GET /pets' method failed:\n", err)
   }
   })();

   成功的调用返回以下输出：

   {
       "statusCode": "200"
   }

   Python

   import botocore
   import boto3
   import logging
   
   logger = logging.getLogger()
   apig = boto3.client('apigateway')
   
   try:
       result = apig.put_method_response(
           restApiId='abcd1234',
           resourceId='aaa111',
           httpMethod='GET',
           statusCode='200'
       )
   except botocore.exceptions.ClientError as error:
       logger.exception("Set up the 200 OK response for the 'GET /pets' method failed %s.", error)
       raise
   attribute=["statusCode"]
   filtered_result ={key:result[key] for key in attribute}
   logger.info(filtered_result)

   成功的调用返回以下输出：

   {'statusCode': '200'}

   AWS CLI

   aws apigateway put-method-response --rest-api-id abcd1234 \ 
     --resource-id aaa111 --http-method GET \
     --status-code 200  --region us-west-2

   此命令的输出如下：

   {
       "statusCode": "200"
   }

7. 使用以下示例为 GET /pets/{petId} 方法添加 200 OK 方法响应：

   JavaScript v3

   import {APIGatewayClient,  PutMethodResponseCommand } from "@aws-sdk/client-api-gateway";
   (async function (){
   const apig = new APIGatewayClient({region:"us-east-1"});
   const command = new PutMethodResponseCommand({
       restApiId: 'abcd1234',
       resourceId: 'bbb222',
       httpMethod: 'GET',
       statusCode: '200'
   });
   try {
       const results = await apig.send(command)
       console.log(results)
   } catch (err) {
       console.log("Set up the 200 OK response for the 'GET /pets/{petId}' method failed:\n", err)
   }
   })();

   成功的调用返回以下输出：

   {
       "statusCode": "200"
   }

   Python

   import botocore
   import boto3
   import logging
   
   logger = logging.getLogger()
   apig = boto3.client('apigateway')
   
   try:
       result = apig.put_method_response(
           restApiId='abcd1234',
           resourceId='bbb222',
           httpMethod='GET',
           statusCode='200'
       )
   except botocore.exceptions.ClientError as error:
       logger.exception("Set up the 200 OK response for the 'GET /pets/{petId}' method failed %s.", error)
       raise
   attribute=["statusCode"]
   filtered_result ={key:result[key] for key in attribute}
   logger.info(filtered_result)

   成功的调用返回以下输出：

   {'statusCode': '200'}

   AWS CLI

   aws apigateway put-method-response --rest-api-id abcd1234 \ 
     --resource-id bbb222 --http-method GET \
     --status-code 200  --region us-west-2

   此命令的输出如下：

   {
       "statusCode": "200"
   }

8. 以下示例使用 HTTP 端点为 GET /pets 方法配置集成。HTTP 端点为 http://petstore-demo-endpoint.execute-api.com/petstore/pets。

   JavaScript v3

   import {APIGatewayClient,  PutIntegrationCommand } from "@aws-sdk/client-api-gateway";
   (async function (){
   const apig = new APIGatewayClient({region:"us-east-1"});
   const command = new PutIntegrationCommand({
       restApiId: 'abcd1234',
       resourceId: 'aaa111',
       httpMethod: 'GET',
       type: 'HTTP',
       integrationHttpMethod: 'GET',
       uri: 'http://petstore-demo-endpoint.execute-api.com/petstore/pets'
   });
   try {
       const results = await apig.send(command)
       console.log(results)
   } catch (err) {
       console.log("Set up the integration of the 'GET /pets' method of the API failed:\n", err)
   }
   })();

   成功的调用返回以下输出：

   {
       "httpMethod": "GET", 
       "passthroughBehavior": "WHEN_NO_MATCH", 
       "cacheKeyParameters": [], 
       "type": "HTTP", 
       "uri": "http://petstore-demo-endpoint.execute-api.com/petstore/pets", 
       "cacheNamespace": "ccc333"
   }

   Python

   import botocore
   import boto3
   import logging
   
   logger = logging.getLogger()
   apig = boto3.client('apigateway')
   
   try:
       result = apig.put_integration(
           restApiId='abcd1234',
           resourceId='aaa111',
           httpMethod='GET',
           type='HTTP',
           integrationHttpMethod='GET',
           uri='http://petstore-demo-endpoint.execute-api.com/petstore/pets'
       )
   except botocore.exceptions.ClientError as error:
       logger.exception("Set up the integration of the 'GET /' method of the API failed %s.", error)
       raise
   attribute=["httpMethod","passthroughBehavior","cacheKeyParameters", "type", "uri", "cacheNamespace"]
   filtered_result ={key:result[key] for key in attribute}
   print(filtered_result)

   成功的调用返回以下输出：

   {'httpMethod': 'GET', 'passthroughBehavior': 'WHEN_NO_MATCH', 'cacheKeyParameters': [], 'type': 'HTTP', 'uri': 'http://petstore-demo-endpoint.execute-api.com/petstore/pets', 'cacheNamespace': 'ccc333'}

   AWS CLI

   aws apigateway put-integration --rest-api-id abcd1234 \
     --resource-id aaa111 --http-method GET --type HTTP \
     --integration-http-method GET \
     --uri 'http://petstore-demo-endpoint.execute-api.com/petstore/pets' \
     --region us-west-2

   此命令的输出如下：

   {
       "type": "HTTP",
       "httpMethod": "GET",
       "uri": "http://petstore-demo-endpoint.execute-api.com/petstore/pets",
       "connectionType": "INTERNET",
       "passthroughBehavior": "WHEN_NO_MATCH",
       "timeoutInMillis": 29000,
       "cacheNamespace": "6sxz2j",
       "cacheKeyParameters": []
   }

9. 以下示例使用 HTTP 端点为 GET /pets/{petId} 方法配置集成。HTTP 端点为 http://petstore-demo-endpoint.execute-api.com/petstore/pets/{id}。在此步骤中，您将路径参数 petId 映射到集成端点路径参数 id。

   JavaScript v3

   import {APIGatewayClient,  PutIntegrationCommand } from "@aws-sdk/client-api-gateway";
   (async function (){
   const apig = new APIGatewayClient({region:"us-east-1"});
   const command = new PutIntegrationCommand({
       restApiId: 'abcd1234',
       resourceId: 'bbb222',
       httpMethod: 'GET',
       type: 'HTTP',
       integrationHttpMethod: 'GET',
       uri: 'http://petstore-demo-endpoint.execute-api.com/petstore/pets/{id}'
       requestParameters: {
           "integration.request.path.id": "method.request.path.petId"
        }
   });
   try {
       const results = await apig.send(command)
       console.log(results)
   } catch (err) {
       console.log("Set up the integration of the 'GET /pets/{petId}' method of the API failed:\n", err)
   }
   })();

   成功的调用返回以下输出：

   {
       "httpMethod": "GET", 
       "passthroughBehavior": "WHEN_NO_MATCH", 
       "cacheKeyParameters": [], 
       "type": "HTTP", 
       "uri": "http://petstore-demo-endpoint.execute-api.com/petstore/pets/{id}", 
       "cacheNamespace": "ddd444",
       "requestParameters": {
          "integration.request.path.id": "method.request.path.petId"
       }
   }

   Python

   import botocore
   import boto3
   import logging
   
   logger = logging.getLogger()
   apig = boto3.client('apigateway')
   
   try:
       result = apig.put_integration(
           restApiId='ieps9b05sf',
           resourceId='t8zeb4',
           httpMethod='GET',
           type='HTTP',
           integrationHttpMethod='GET',
           uri='http://petstore-demo-endpoint.execute-api.com/petstore/pets/{id}',
           requestParameters={
               "integration.request.path.id": "method.request.path.petId"
           }
       )
   except botocore.exceptions.ClientError as error:
       logger.exception("Set up the integration of the 'GET /pets/{petId}' method of the API failed %s.", error)
       raise
   attribute=["httpMethod","passthroughBehavior","cacheKeyParameters", "type", "uri", "cacheNamespace", "requestParameters"]
   filtered_result ={key:result[key] for key in attribute}
   print(filtered_result)

   成功的调用返回以下输出：

   {'httpMethod': 'GET', 'passthroughBehavior': 'WHEN_NO_MATCH', 'cacheKeyParameters': [], 'type': 'HTTP', 'uri': 'http://petstore-demo-endpoint.execute-api.com/petstore/pets/{id}', 'cacheNamespace': 'ddd444', 'requestParameters': {'integration.request.path.id': 'method.request.path.petId'}}}

   AWS CLI

   aws apigateway put-integration --rest-api-id abcd1234 \
     --resource-id bbb222 --http-method GET --type HTTP \
     --integration-http-method GET \
     --uri 'http://petstore-demo-endpoint.execute-api.com/petstore/pets/{id}' \ 
     --request-parameters '{"integration.request.path.id":"method.request.path.petId"}' \
     --region us-west-2

   此命令的输出如下：

   {
       "type": "HTTP",
       "httpMethod": "GET",
       "uri": "http://petstore-demo-endpoint.execute-api.com/petstore/pets/{id}",
       "connectionType": "INTERNET",
       "requestParameters": {
           "integration.request.path.id": "method.request.path.petId"
       },
       "passthroughBehavior": "WHEN_NO_MATCH",
       "timeoutInMillis": 29000,
       "cacheNamespace": "rjkmth",
       "cacheKeyParameters": []
   }

10. 以下示例添加 GET /pets 集成的集成响应：

    JavaScript v3

    import {APIGatewayClient,  PutIntegrationResponseCommand } from "@aws-sdk/client-api-gateway";
    (async function (){
    const apig = new APIGatewayClient({region:"us-east-1"});
    const command = new PutIntegrationResponseCommand({
        restApiId: 'abcd1234',
        resourceId: 'aaa111',
        httpMethod: 'GET',
        statusCode: '200',
        selectionPattern: ''
    });
    try {
        const results = await apig.send(command)
        console.log(results)
    } catch (err) {
        console.log("The 'GET /pets' method integration response setup failed:\n", err)
    }
    })();

    成功的调用返回以下输出：

    {
        "selectionPattern": "", 
        "statusCode": "200"
    }

    Python

    import botocore
    import boto3
    import logging
    
    logger = logging.getLogger()
    apig = boto3.client('apigateway')
    
    try:
        result = apig.put_integration_response(
            restApiId='abcd1234',
            resourceId='aaa111',
            httpMethod='GET',
            statusCode='200',
            selectionPattern='',
        )
    except botocore.exceptions.ClientError as error:
        logger.exception("Set up the integration response of the 'GET /pets' method of the API failed: %s", error)
        raise
    attribute=["selectionPattern","statusCode"]
    filtered_result ={key:result[key] for key in attribute}
    print(filtered_result)

    成功的调用返回以下输出：

    {'selectionPattern': "", 'statusCode': '200'}

    AWS CLI

    aws apigateway put-integration-response --rest-api-id abcd1234 \
      --resource-id aaa111 --http-method GET \
      --status-code 200 --selection-pattern ""  \
      --region us-west-2

    此命令的输出如下：

    {
        "statusCode": "200",
        "selectionPattern": "" 
    }

11. 以下示例添加 GET /pets/{petId} 集成的集成响应：

    JavaScript v3

    import {APIGatewayClient,  PutIntegrationResponseCommand } from "@aws-sdk/client-api-gateway";
    (async function (){
    const apig = new APIGatewayClient({region:"us-east-1"});
    const command = new PutIntegrationResponseCommand({
        restApiId: 'abcd1234',
        resourceId: 'bbb222',
        httpMethod: 'GET',
        statusCode: '200',
        selectionPattern: ''
    });
    try {
        const results = await apig.send(command)
        console.log(results)
    } catch (err) {
        console.log("The 'GET /pets/{petId}' method integration response setup failed:\n", err)
    }
    })();

    成功的调用返回以下输出：

    {
        "selectionPattern": "", 
        "statusCode": "200"
    }

    Python

    import botocore
    import boto3
    import logging
    
    logger = logging.getLogger()
    apig = boto3.client('apigateway')
    
    try:
        result = apig.put_integration_response(
            restApiId='abcd1234',
            resourceId='bbb222',
            httpMethod='GET',
            statusCode='200',
            selectionPattern='',
        )
    except botocore.exceptions.ClientError as error:
        logger.exception("Set up the integration response of the 'GET /pets/{petId}' method of the API failed: %s", error)
        raise
    attribute=["selectionPattern","statusCode"]
    filtered_result ={key:result[key] for key in attribute}
    print(filtered_result)

    成功的调用返回以下输出：

    {'selectionPattern': "", 'statusCode': '200'}

    AWS CLI

    aws apigateway put-integration-response --rest-api-id abcd1234 \
      --resource-id bbb222 --http-method GET 
      --status-code 200 --selection-pattern ""  
      --region us-west-2

    此命令的输出如下：

    {
        "statusCode": "200",
        "selectionPattern": "" 
    }

    创建集成响应后，API 可以在 PetStore 网站上查询所提供的宠物，并查看指定标识符的单个宠物。在客户能够调用 API 之前，您必须先部署该 API。我们建议您在部署 API 之前先对其进行测试。

12. 以下示例测试 GET /pets 方法：

    JavaScript v3

    import {APIGatewayClient,  TestInvokeMethodCommand } from "@aws-sdk/client-api-gateway";
    (async function (){
    const apig = new APIGatewayClient({region:"us-east-1"});
    const command = new TestInvokeMethodCommand({
        restApiId: 'abcd1234',
        resourceId: 'aaa111',
        httpMethod: 'GET',
        pathWithQueryString: '/',
    });
    try {
        const results = await apig.send(command)
        console.log(results)
    } catch (err) {
        console.log("The test on 'GET /pets' method failed:\n", err)
    }
    })();

    Python

    import botocore
    import boto3
    import logging
    
    logger = logging.getLogger()
    apig = boto3.client('apigateway')
    
    try:
        result = apig.test_invoke_method(
            restApiId='abcd1234',
            resourceId='aaa111',
            httpMethod='GET',
            pathWithQueryString='/',
        )
    except botocore.exceptions.ClientError as error:
        logger.exception("Test invoke method on 'GET /pets' failed: %s", error)
        raise
    print(result)

    AWS CLI

    aws apigateway test-invoke-method --rest-api-id abcd1234 /
      --resource-id aaa111 /
      --http-method GET /
      --path-with-query-string '/'

13. 以下示例以 petId 为 3 来测试 GET /pets/{petId} 方法：

    JavaScript v3

    import {APIGatewayClient,  TestInvokeMethodCommand } from "@aws-sdk/client-api-gateway";
    (async function (){
    const apig = new APIGatewayClient({region:"us-east-1"});
    const command = new TestInvokeMethodCommand({
        restApiId: 'abcd1234',
        resourceId: 'bbb222',
        httpMethod: 'GET',
        pathWithQueryString: '/pets/3',
    });
    try {
        const results = await apig.send(command)
        console.log(results)
    } catch (err) {
        console.log("The test on 'GET /pets/{petId}' method failed:\n", err)
    }
    })();

    Python

    import botocore
    import boto3
    import logging
    
    logger = logging.getLogger()
    apig = boto3.client('apigateway')
    
    try:
        result = apig.test_invoke_method(
            restApiId='abcd1234',
            resourceId='bbb222',
            httpMethod='GET',
            pathWithQueryString='/pets/3',
        )
    except botocore.exceptions.ClientError as error:
        logger.exception("Test invoke method on 'GET /pets/{petId}' failed: %s", error)
        raise
    print(result)

    AWS CLI

    aws apigateway test-invoke-method --rest-api-id abcd1234 /
      --resource-id bbb222 /
      --http-method GET /
      --path-with-query-string '/pets/3'

    成功测试 API 后，您可以将其部署到阶段。

14. 以下示例将 API 部署到名为 test 的阶段。将 API 部署到阶段时，API 调用方可以调用 API。

    JavaScript v3

    import {APIGatewayClient,  CreateDeploymentCommand } from "@aws-sdk/client-api-gateway";
    (async function (){
    const apig = new APIGatewayClient({region:"us-east-1"});
    const command = new CreateDeploymentCommand({
        restApiId: 'abcd1234',
        stageName: 'test',
        stageDescription: 'test deployment'
    });
    try {
        const results = await apig.send(command)
        console.log("Deploying API succeeded\n", results)
    } catch (err) {
        console.log("Deploying API failed:\n", err)
    }
    })();

    Python

    import botocore
    import boto3
    import logging
    
    logger = logging.getLogger()
    apig = boto3.client('apigateway')
    
    try:
        result = apig.create_deployment(
            restApiId='ieps9b05sf',
            stageName='test',
            stageDescription='my test stage',
        )
    except botocore.exceptions.ClientError as error:
        logger.exception("Error deploying stage  %s.", error)
        raise
    print('Deploying API succeeded')
    print(result)

    AWS CLI

    aws apigateway create-deployment --rest-api-id abcd1234 \ 
      --region us-west-2 \
      --stage-name test \
      --stage-description 'Test stage' \
      --description 'First deployment'

    此命令的输出如下：

    {
        "id": "ab1c1d",
        "description": "First deployment",
        "createdDate": "2022-12-15T08:44:13-08:00"
    }

    现在，客户可以调用您的 API 了。您可以通过在浏览器中输入 https://abcd1234.execute-api.us-west-2.amazonaws.com/test/pets URL 并将 abcd1234 替换为 API 的标识符，测试此 API。