Gunakan yang JavaScript SDK dihasilkan oleh API Gateway untuk REST API

Untuk menginstal, memulai dan memanggil yang JavaScript SDK dihasilkan oleh API Gateway untuk REST API

1. Ekstrak konten file.zip yang API dihasilkan Gateway yang Anda unduh sebelumnya.

2. Aktifkan berbagi sumber daya lintas asal (CORS) untuk semua metode yang akan SDK dipanggil oleh API Gateway. Untuk petunjuk, lihat CORSuntuk REST APIs di API Gateway.

3. Di halaman web Anda, sertakan referensi ke skrip berikut.

   <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. Dalam kode Anda, inisialisasi yang SDK dihasilkan oleh API Gateway dengan menggunakan kode yang mirip dengan berikut ini.

   var apigClient = apigClientFactory.newClient();

   Untuk menginisialisasi yang SDK dihasilkan oleh API Gateway dengan AWS kredensi, gunakan kode yang mirip dengan berikut ini. Jika Anda menggunakan AWS kredensi, semua permintaan API akan ditandatangani.

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

   Untuk menggunakan API kunci dengan yang SDK dihasilkan oleh API Gateway, berikan API kunci sebagai parameter ke Factory objek dengan menggunakan kode yang mirip dengan berikut ini. Jika Anda menggunakan API kunci, itu ditentukan sebagai bagian dari x-api-key header dan semua permintaan ke API akan ditandatangani. Ini berarti Anda harus mengatur header CORS Terima yang sesuai untuk setiap permintaan.

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

5. Panggil API metode di API Gateway dengan menggunakan kode yang mirip dengan berikut ini. Setiap panggilan mengembalikan janji dengan callback sukses dan gagal.

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

   Di sini, methodName dibangun dari jalur sumber daya permintaan metode dan HTTP kata kerja. Untuk SimpleCalc API, SDK metode untuk API metode

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

   SDKmetode yang sesuai adalah sebagai berikut:

   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