Création du kit SDK pour les navigateurs - AWS SDK for JavaScript

Nous avons annoncé la sortie end-of-support de la AWS SDK for JavaScript v2. Nous vous recommandons de migrer vers la AWS SDK for JavaScript version 3. Pour les dates, les détails supplémentaires et les informations sur la façon de migrer, reportez-vous à l'annonce associée.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Création du kit SDK pour les navigateurs

Le SDK pour JavaScript est fourni sous forme de JavaScript fichier avec prise en charge d'un ensemble de services par défaut. Ce fichier est généralement chargé dans les scripts du navigateur à l'aide d'une balise <script> qui référence le package du kit SDK hébergé. Cependant, la prise en charge de services autres que l'ensemble par défaut peut être nécessaire ; sinon, vous devrez personnaliser le kit SDK.

Si vous travaillez avec le SDK en dehors d'un environnement qui applique CORS dans votre navigateur et si vous souhaitez accéder à tous les services fournis par le SDK pour JavaScript, vous pouvez créer une copie personnalisée du SDK localement en clonant le référentiel et en exécutant les mêmes outils de génération que ceux utilisés pour créer la version hébergée par défaut du SDK. Les sections suivantes décrivent les étapes à suivre pour créer le kit SDK avec des services et des versions d'API supplémentaires.

Utilisation du générateur de SDK pour créer le SDK pour JavaScript

Le moyen le plus simple de créer votre propre version du AWS SDK for JavaScript est d'utiliser l'application Web SDK Builder à l'adresse https://sdk.amazonaws.com/builder/js. Utilisez le générateur de kits SDK pour spécifier des services, et leurs versions d'API, à inclure dans votre génération.

Choisissez Select all services (Sélectionner tous les services) ou Select default services (Sélectionner les services par défaut) comme point de départ à partir duquel ajouter ou supprimer des services. Choisissez Development (Développement) pour obtenir un code plus lisible ou Minified (Réduit) pour créer une génération réduite à déployer. Après avoir choisi les services et les versions à inclure, choisissez Build (Créer) pour générer et télécharger votre kit SDK personnalisé.

Utilisation de la CLI pour créer le SDK pour JavaScript

Pour créer le SDK destiné à JavaScript utiliser le AWS CLI, vous devez d'abord cloner le référentiel Git qui contient la source du SDK. Vous devez avoir installé Git et Node.js sur votre ordinateur.

Tout d'abord, clonez le dépôt depuis GitHub et changez-le de répertoire dans le répertoire :

git clone https://github.com/aws/aws-sdk-js.git cd aws-sdk-js

Après avoir cloné le référentiel, téléchargez les modules de dépendance pour le kit SDK et l'outil de génération :

npm install

Vous pouvez désormais générer une version en package du kit SDK.

Création à partir de la ligne de commande

L'outil de génération se trouve dans dist-tools/browser-builder.js. Exécutez ce script en tapant :

node dist-tools/browser-builder.js > aws-sdk.js

Cette commande crée le fichier aws-sdk.js. Ce fichier est décompressé. Par défaut, ce package comprend uniquement l'ensemble de services standard.

Réduction de la sortie de génération

Pour réduire la quantité de données sur le réseau, les JavaScript fichiers peuvent être compressés par le biais d'un processus appelé minification. La minification supprime les commentaires, les espaces inutiles et d'autres caractères qui facilitent la lisibilité par les humains sans nuire à l'exécution du code. L'outil de génération peut produire une sortie non compressée ou réduite. Pour réduire votre sortie de génération, définissez la variable d'environnement MINIFY :

MINIFY=1 node dist-tools/browser-builder.js > aws-sdk.js

Création de services et de versions d'API spécifiques

Vous pouvez sélectionner les services à inclure dans le kit SDK. Pour sélectionner les services, spécifiez les noms de services, délimités par des virgules, comme paramètres. Par exemple, pour créer uniquement Amazon S3 et Amazon EC2, utilisez la commande suivante :

node dist-tools/browser-builder.js s3,ec2 > aws-sdk-s3-ec2.js

Vous pouvez également sélectionner des versions d'API spécifiques des générations de services en ajoutant le nom de version après le nom du service. Par exemple, pour créer les deux versions d'API d'Amazon DynamoDB, utilisez la commande suivante :

node dist-tools/browser-builder.js dynamodb-2011-12-05,dynamodb-2012-08-10

Les identificateurs de service et les versions d'API sont disponibles dans les fichiers de configuration spécifiques au service à l'adresse https://github.com/aws/ /tree/master/apis. aws-sdk-js

Création de tous les services

Vous pouvez générer tous les services et versions d'API en incluant le paramètre all :

node dist-tools/browser-builder.js all > aws-sdk-full.js

Création de services spécifiques

Pour personnaliser l'ensemble de services inclus dans la génération, transmettez la variable d'environnement AWS_SERVICES à la commande Browserify qui contient la liste des services que vous souhaitez. L'exemple suivant crée les services Amazon EC2, Amazon S3 et DynamoDB.

$ AWS_SERVICES=ec2,s3,dynamodb browserify index.js > browser-app.js

Création du kit SDK en tant que dépendance avec Browserify

Node.js comprend un mécanisme basé sur un module permettant d'inclure le code et les fonctionnalités de développeurs tiers. Cette approche modulaire n'est pas prise en charge de manière native par l' JavaScript exécution dans les navigateurs Web. Toutefois, avec l'outil Browserify, vous pouvez appliquer l'approche modulaire Node.js et utiliser les modules écrits pour Node.js dans le navigateur. Browserify crée les dépendances des modules pour un script de navigateur dans un JavaScript fichier unique et autonome que vous pouvez utiliser dans le navigateur.

Vous pouvez créer le kit SDK en tant que dépendance de bibliothèque pour n'importe quel script de navigateur en utilisant Browserify. Par exemple, le code Node.js suivant nécessite le kit SDK :

var AWS = require('aws-sdk'); var s3 = new AWS.S3(); s3.listBuckets(function(err, data) { console.log(err, data); });

Cet exemple de code peut être compilé dans une version compatible avec un navigateur en utilisant Browserify :

$ browserify index.js > browser-app.js

L'application, y compris ses dépendances du kit SDK, devient alors disponible dans le navigateur par l'intermédiaire de browser-app.js.

Pour plus d'informations sur Browserify, consultez le site web Browserify.