Verwenden Sie ein von API Gateway generiertes JavaScript SDK für eine REST-API

Das folgende Verfahren zeigt, wie Sie ein von API Gateway generiertes JavaScript SDK verwenden.

Anmerkung

Für diese Anleitungen müssen Sie die Anleitungen unter Generieren Sie SDKs für REST APIs in API Gateway ausgeführt haben.

Wichtig

Wenn für Ihre API nur ANY-Methoden definiert wurden, enthält das generierte SDK-Paket keine apigClient.js-Datei und Sie müssen die ANY-Methoden selbst definieren.

Um ein von API Gateway generiertes JavaScript SDK für eine REST-API zu installieren, zu initiieren und aufzurufen

1. Extrahieren Sie den Inhalt der von API Gateway generierten ZIP-Datei, die Sie zuvor heruntergeladen haben.

2. Aktivieren Sie Cross-Origin Resource Sharing (CORS) für alle Methoden, die das von API Gateway generierte SDK aufrufen werden. Detaillierte Anweisungen finden Sie unter CORS für REST APIs im API Gateway.

3. Bauen Sie in Ihre Webseite Verweise auf die folgenden Scripts ein.

   <script type="text/javascript" src="lib/axios/dist/axios.standalone.js"></script>
   <script type="text/javascript" src="lib/CryptoJS/rollups/hmac-sha256.js"></script>
   <script type="text/javascript" src="lib/CryptoJS/rollups/sha256.js"></script>
   <script type="text/javascript" src="lib/CryptoJS/components/hmac.js"></script>
   <script type="text/javascript" src="lib/CryptoJS/components/enc-base64.js"></script>
   <script type="text/javascript" src="lib/url-template/url-template.js"></script>
   <script type="text/javascript" src="lib/apiGatewayCore/sigV4Client.js"></script>
   <script type="text/javascript" src="lib/apiGatewayCore/apiGatewayClient.js"></script>
   <script type="text/javascript" src="lib/apiGatewayCore/simpleHttpClient.js"></script>
   <script type="text/javascript" src="lib/apiGatewayCore/utils.js"></script>
   <script type="text/javascript" src="apigClient.js"></script>

4. Initialisieren Sie in Ihrem Code das von API Gateway generierte SDK, indem Sie Code ähnlich dem folgenden verwenden.

   var apigClient = apigClientFactory.newClient();

   Verwenden Sie Code, der dem folgenden ähnelt, um das von API Gateway generierte SDK mit AWS Anmeldeinformationen zu initialisieren. Wenn Sie AWS Anmeldeinformationen verwenden, werden alle Anfragen an die API signiert.

   var apigClient = apigClientFactory.newClient({
     accessKey: 'ACCESS_KEY',
     secretKey: 'SECRET_KEY',
   });

   Um einen API-Schlüssel mit dem von API Gateway generierten SDK zu verwenden, übergeben Sie den API-Schlüssel als Parameter an das Factory-Objekt, indem Sie Code ähnlich dem folgenden verwenden. Wenn Sie einen API-Schlüssel verwenden, ist dieser als Teil des x-api-key-Headers spezifiziert, und alle Anforderungen an die API werden signiert. Das bedeutet, dass Sie die entsprechenden CORS Accept-Header für jede Anforderung festlegen müssen.

   var apigClient = apigClientFactory.newClient({
     apiKey: 'API_KEY'
   });

5. Rufen Sie die API-Methoden in API Gateway auf, indem Sie Code ähnlich dem folgenden verwenden. Jeder Aufruf gibt eine Zusage mit erfolgreichen und fehlgeschlagenen Callbacks zurück.

   var params = {
     // This is where any modeled request parameters should be added.
     // The key is the parameter name, as it is defined in the API in API Gateway.
     param0: '',
     param1: ''
   };
   
   var body = {
     // This is where you define the body of the request,
   };
   
   var additionalParams = {
     // If there are any unmodeled query parameters or headers that must be
     //   sent with the request, add them here.
     headers: {
       param0: '',
       param1: ''
     },
     queryParams: {
       param0: '',
       param1: ''
     }
   };
   
   apigClient.methodName(params, body, additionalParams)
       .then(function(result){
         // Add success callback code here.
       }).catch( function(result){
         // Add error callback code here.
       });

   Hier methodName wird das aus dem Ressourcenpfad der Methodenanforderung und dem HTTP-Verb erstellt. Für die SimpleCalc API die SDK-Methoden für die API-Methoden von

   1. GET /?a=...&b=...&op=...
   2. POST /
   
      { "a": ..., "b": ..., "op": ...}
   3. GET /{a}/{b}/{op}

   Die entsprechenden SDK-Methoden sind:

   1. rootGet(params);      // where params={"a": ..., "b": ..., "op": ...} is resolved to the query parameters
   2. rootPost(null, body); // where body={"a": ..., "b": ..., "op": ...}
   3. aBOpGet(params);      // where params={"a": ..., "b": ..., "op": ...} is resolved to the path parameters