Usa un file JavaScript SDK generato da API Gateway per un REST API

La procedura seguente mostra come utilizzare un file JavaScript SDK generato da API Gateway.

Nota

Queste istruzioni presuppongono che tu abbia già completato la procedura descritta in Genera SDKs per REST APIs in API Gateway.

Importante

Se sono stati definiti API solo ANY metodi, il SDK pacchetto generato non conterrà alcun apigClient.js file e sarà necessario definire i ANY metodi autonomamente.

Per installare, avviare e richiamare un file JavaScript SDK generato da API Gateway for a REST API

1. Estrai il contenuto del file.zip API generato dal Gateway che hai scaricato in precedenza.

2. Abilita la condivisione delle risorse tra le origini (CORS) per tutti i metodi che verranno richiamati dal Gateway SDK generato. API Per istruzioni, consulta CORSper REST APIs in API Gateway.

3. Nella tua pagina Web, includi i riferimenti ai seguenti script.

   <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. Nel codice, inizializza quello SDK generato da API Gateway utilizzando un codice simile al seguente.

   var apigClient = apigClientFactory.newClient();

   Per inizializzare il codice SDK generato da API Gateway con AWS le credenziali, utilizzate un codice simile al seguente. Se si utilizzano AWS le credenziali, tutte le richieste API verranno firmate.

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

   Per utilizzare una API chiave con quella SDK generata da API Gateway, passatela API come parametro all'Factoryoggetto utilizzando un codice simile al seguente. Se usi una API chiave, questa viene specificata come parte dell'x-api-keyintestazione e tutte le richieste API verranno firmate. Ciò significa che è necessario impostare le intestazioni CORS Accept appropriate per ogni richiesta.

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

5. Chiama i API metodi in API Gateway utilizzando un codice simile al seguente. Ogni chiamata restituisce una promessa con callback di successo e di fallimento.

   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.
       });

   Ecco, il methodName è costruito dal percorso delle risorse della richiesta del metodo e dal HTTP verbo. Per SimpleCalc API, i SDK metodi per i API metodi di

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

   i SDK metodi corrispondenti sono i seguenti:

   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