-
Notifications
You must be signed in to change notification settings - Fork 402
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
54 changed files
with
6,084 additions
and
70 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
# Prerequisites | ||
For the JavaScript SDK to work your APIs need to support CORS. The Amazon API Gateway developer guide explains how to [setup CORS for an endpoint](). | ||
The generated SDK depends on third-party libraries. Include all of the scripts in your webpage | ||
|
||
<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> | ||
|
||
# Use the SDK in your project | ||
|
||
To initialize the most basic form of the SDK: | ||
|
||
``` | ||
var apigClient = apigClientFactory.newClient(); | ||
``` | ||
|
||
Calls to an API take the form outlined below. Each API call returns a promise, that invokes either a success and failure callback | ||
|
||
``` | ||
var params = { | ||
//This is where any header, path, or querystring request params go. The key is the parameter named as defined in the API | ||
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 need to be sent with the request you can add them here | ||
headers: { | ||
param0: '', | ||
param1: '' | ||
}, | ||
queryParams: { | ||
param0: '', | ||
param1: '' | ||
} | ||
}; | ||
apigClient.methodName(params, body, additionalParams) | ||
.then(function(result){ | ||
//This is where you would put a success callback | ||
}).catch( function(result){ | ||
//This is where you would put an error callback | ||
}); | ||
``` | ||
|
||
#Using AWS IAM for authorization | ||
To initialize the SDK with AWS Credentials use the code below. Note, if you use credentials all requests to the API will be signed. This means you will have to set the appropiate CORS accept-* headers for each request. | ||
|
||
``` | ||
var apigClient = apigClientFactory.newClient({ | ||
accessKey: 'ACCESS_KEY', | ||
secretKey: 'SECRET_KEY', | ||
sessionToken: 'SESSION_TOKEN', //OPTIONAL: If you are using temporary credentials you must include the session token | ||
region: 'us-east-1' // OPTIONAL: The region where the API is deployed (e.g. eu-west-1, us-west-2). Defaults to us-east-1. | ||
}); | ||
``` | ||
|
||
#Using API Keys | ||
To use an API Key with the client SDK you can pass the key as a parameter to the Factory object. Note, if you use an apiKey it will be attached as the header 'x-api-key' to all requests to the API will be signed. This means you will have to set the appropiate CORS accept-* headers for each request. | ||
|
||
``` | ||
var apigClient = apigClientFactory.newClient({ | ||
apiKey: 'API_KEY' | ||
}); | ||
``` | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,173 @@ | ||
/* eslint-disable */ | ||
/* | ||
* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"). | ||
* You may not use this file except in compliance with the License. | ||
* A copy of the License is located at | ||
* | ||
* http://aws.amazon.com/apache2.0 | ||
* | ||
* or in the "license" file accompanying this file. This file is distributed | ||
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
* express or implied. See the License for the specific language governing | ||
* permissions and limitations under the License. | ||
*/ | ||
|
||
var apigClientFactory = {}; | ||
apigClientFactory.newClient = function (config) { | ||
var apigClient = { }; | ||
if(config === undefined) { | ||
config = { | ||
accessKey: '', | ||
secretKey: '', | ||
sessionToken: '', | ||
region: '', | ||
apiKey: undefined, | ||
defaultContentType: 'application/json', | ||
defaultAcceptType: 'application/json' | ||
}; | ||
} | ||
if(config.accessKey === undefined) { | ||
config.accessKey = ''; | ||
} | ||
if(config.secretKey === undefined) { | ||
config.secretKey = ''; | ||
} | ||
if(config.apiKey === undefined) { | ||
config.apiKey = ''; | ||
} | ||
if(config.sessionToken === undefined) { | ||
config.sessionToken = ''; | ||
} | ||
if(config.region === undefined) { | ||
config.region = 'YOUR_PRIMARY_AWS_REGION'; | ||
} | ||
//If defaultContentType is not defined then default to application/json | ||
if(config.defaultContentType === undefined) { | ||
config.defaultContentType = 'application/json'; | ||
} | ||
//If defaultAcceptType is not defined then default to application/json | ||
if(config.defaultAcceptType === undefined) { | ||
config.defaultAcceptType = 'application/json'; | ||
} | ||
|
||
// extract endpoint and path from url | ||
let invokeUrl = `https://${window.config.restApiId}.execute-api.${window.config.region}.amazonaws.com/prod`, | ||
endpoint = /(^https?:\/\/[^\/]+)/g.exec(invokeUrl)[1], | ||
pathComponent = invokeUrl.substring(endpoint.length) | ||
|
||
var sigV4ClientConfig = { | ||
accessKey: config.accessKey, | ||
secretKey: config.secretKey, | ||
sessionToken: config.sessionToken, | ||
serviceName: 'execute-api', | ||
region: config.region, | ||
endpoint: endpoint, | ||
defaultContentType: config.defaultContentType, | ||
defaultAcceptType: config.defaultAcceptType | ||
}; | ||
|
||
var authType = 'NONE'; | ||
if (sigV4ClientConfig.accessKey !== undefined && sigV4ClientConfig.accessKey !== '' && sigV4ClientConfig.secretKey !== undefined && sigV4ClientConfig.secretKey !== '') { | ||
authType = 'AWS_IAM'; | ||
} | ||
|
||
var simpleHttpClientConfig = { | ||
endpoint: endpoint, | ||
defaultContentType: config.defaultContentType, | ||
defaultAcceptType: config.defaultAcceptType | ||
}; | ||
|
||
var apiGatewayClient = apiGateway.core.apiGatewayClientFactory.newClient(simpleHttpClientConfig, sigV4ClientConfig); | ||
|
||
|
||
|
||
apigClient.rootOptions = function (params, body, additionalParams) { | ||
if(additionalParams === undefined) { additionalParams = {}; } | ||
|
||
apiGateway.core.utils.assertParametersDefined(params, [], ['body']); | ||
|
||
var rootOptionsRequest = { | ||
verb: 'options'.toUpperCase(), | ||
path: pathComponent + uritemplate('/').expand(apiGateway.core.utils.parseParametersToObject(params, [])), | ||
headers: apiGateway.core.utils.parseParametersToObject(params, []), | ||
queryParams: apiGateway.core.utils.parseParametersToObject(params, []), | ||
body: body | ||
}; | ||
|
||
|
||
return apiGatewayClient.makeRequest(rootOptionsRequest, authType, additionalParams, config.apiKey); | ||
}; | ||
|
||
|
||
apigClient.get = function (path, params, body, additionalParams) { | ||
if(additionalParams === undefined) { additionalParams = {}; } | ||
|
||
apiGateway.core.utils.assertParametersDefined(params, [], ['body']); | ||
|
||
var proxyOptionsRequest = { | ||
verb: 'GET', | ||
path: pathComponent + path, | ||
headers: apiGateway.core.utils.parseParametersToObject(params, []), | ||
queryParams: apiGateway.core.utils.parseParametersToObject(params, ['start', 'end', 'sdkType']), | ||
body: body | ||
}; | ||
|
||
return apiGatewayClient.makeRequest(proxyOptionsRequest, authType, additionalParams, config.apiKey); | ||
}; | ||
|
||
apigClient.post = function (path, params, body, additionalParams) { | ||
if(additionalParams === undefined) { additionalParams = {}; } | ||
|
||
apiGateway.core.utils.assertParametersDefined(params, [], ['body']); | ||
|
||
var proxyOptionsRequest = { | ||
verb: 'POST', | ||
path: pathComponent + path, | ||
headers: apiGateway.core.utils.parseParametersToObject(params, []), | ||
queryParams: apiGateway.core.utils.parseParametersToObject(params, []), | ||
body: body | ||
}; | ||
|
||
|
||
return apiGatewayClient.makeRequest(proxyOptionsRequest, authType, additionalParams, config.apiKey); | ||
}; | ||
|
||
apigClient.put = function (path, params, body, additionalParams) { | ||
if(additionalParams === undefined) { additionalParams = {}; } | ||
|
||
apiGateway.core.utils.assertParametersDefined(params, [], ['body']); | ||
|
||
var proxyOptionsRequest = { | ||
verb: 'PUT', | ||
path: pathComponent + path, | ||
headers: apiGateway.core.utils.parseParametersToObject(params, []), | ||
queryParams: apiGateway.core.utils.parseParametersToObject(params, []), | ||
body: body | ||
}; | ||
|
||
|
||
return apiGatewayClient.makeRequest(proxyOptionsRequest, authType, additionalParams, config.apiKey); | ||
}; | ||
|
||
apigClient.delete = function (path, params, body, additionalParams) { | ||
if(additionalParams === undefined) { additionalParams = {}; } | ||
|
||
apiGateway.core.utils.assertParametersDefined(params, [], ['body']); | ||
|
||
var proxyOptionsRequest = { | ||
verb: 'DELETE', | ||
path: pathComponent + path, | ||
headers: apiGateway.core.utils.parseParametersToObject(params, []), | ||
queryParams: apiGateway.core.utils.parseParametersToObject(params, []), | ||
body: body | ||
}; | ||
|
||
|
||
return apiGatewayClient.makeRequest(proxyOptionsRequest, authType, additionalParams, config.apiKey); | ||
}; | ||
|
||
|
||
return apigClient; | ||
}; |
109 changes: 109 additions & 0 deletions
109
dev-portal/build/apigateway-js-sdk/lib/CryptoJS/components/enc-base64.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
/* | ||
CryptoJS v3.1.2 | ||
code.google.com/p/crypto-js | ||
(c) 2009-2013 by Jeff Mott. All rights reserved. | ||
code.google.com/p/crypto-js/wiki/License | ||
*/ | ||
(function () { | ||
// Shortcuts | ||
var C = CryptoJS; | ||
var C_lib = C.lib; | ||
var WordArray = C_lib.WordArray; | ||
var C_enc = C.enc; | ||
|
||
/** | ||
* Base64 encoding strategy. | ||
*/ | ||
var Base64 = C_enc.Base64 = { | ||
/** | ||
* Converts a word array to a Base64 string. | ||
* | ||
* @param {WordArray} wordArray The word array. | ||
* | ||
* @return {string} The Base64 string. | ||
* | ||
* @static | ||
* | ||
* @example | ||
* | ||
* var base64String = CryptoJS.enc.Base64.stringify(wordArray); | ||
*/ | ||
stringify: function (wordArray) { | ||
// Shortcuts | ||
var words = wordArray.words; | ||
var sigBytes = wordArray.sigBytes; | ||
var map = this._map; | ||
|
||
// Clamp excess bits | ||
wordArray.clamp(); | ||
|
||
// Convert | ||
var base64Chars = []; | ||
for (var i = 0; i < sigBytes; i += 3) { | ||
var byte1 = (words[i >>> 2] >>> (24 - (i % 4) * 8)) & 0xff; | ||
var byte2 = (words[(i + 1) >>> 2] >>> (24 - ((i + 1) % 4) * 8)) & 0xff; | ||
var byte3 = (words[(i + 2) >>> 2] >>> (24 - ((i + 2) % 4) * 8)) & 0xff; | ||
|
||
var triplet = (byte1 << 16) | (byte2 << 8) | byte3; | ||
|
||
for (var j = 0; (j < 4) && (i + j * 0.75 < sigBytes); j++) { | ||
base64Chars.push(map.charAt((triplet >>> (6 * (3 - j))) & 0x3f)); | ||
} | ||
} | ||
|
||
// Add padding | ||
var paddingChar = map.charAt(64); | ||
if (paddingChar) { | ||
while (base64Chars.length % 4) { | ||
base64Chars.push(paddingChar); | ||
} | ||
} | ||
|
||
return base64Chars.join(''); | ||
}, | ||
|
||
/** | ||
* Converts a Base64 string to a word array. | ||
* | ||
* @param {string} base64Str The Base64 string. | ||
* | ||
* @return {WordArray} The word array. | ||
* | ||
* @static | ||
* | ||
* @example | ||
* | ||
* var wordArray = CryptoJS.enc.Base64.parse(base64String); | ||
*/ | ||
parse: function (base64Str) { | ||
// Shortcuts | ||
var base64StrLength = base64Str.length; | ||
var map = this._map; | ||
|
||
// Ignore padding | ||
var paddingChar = map.charAt(64); | ||
if (paddingChar) { | ||
var paddingIndex = base64Str.indexOf(paddingChar); | ||
if (paddingIndex != -1) { | ||
base64StrLength = paddingIndex; | ||
} | ||
} | ||
|
||
// Convert | ||
var words = []; | ||
var nBytes = 0; | ||
for (var i = 0; i < base64StrLength; i++) { | ||
if (i % 4) { | ||
var bits1 = map.indexOf(base64Str.charAt(i - 1)) << ((i % 4) * 2); | ||
var bits2 = map.indexOf(base64Str.charAt(i)) >>> (6 - (i % 4) * 2); | ||
words[nBytes >>> 2] |= (bits1 | bits2) << (24 - (nBytes % 4) * 8); | ||
nBytes++; | ||
} | ||
} | ||
|
||
return WordArray.create(words, nBytes); | ||
}, | ||
|
||
_map: 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=' | ||
}; | ||
}()); |
Oops, something went wrong.