Creación del SDK para navegadores - AWS SDK for JavaScript

Anunciamos la próxima AWS SDK for JavaScript versión end-of-support para la versión 2. Le recomendamos que migre a la AWS SDK for JavaScript versión 3. Para ver las fechas, los detalles adicionales y la información sobre cómo realizar la migración, consulte el anuncio enlazado.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Creación del SDK para navegadores

El SDK para JavaScript se proporciona como un JavaScript archivo con soporte incluido para un conjunto de servicios predeterminado. Este archivo suele cargarse en scripts de navegador mediante una etiqueta <script> que hace referencia al paquete de SDK alojado. Sin embargo, es posible que necesite soporte para servicios que no sean el conjunto predeterminado o bien que necesite personalizar el SDK.

Si trabaja con el SDK fuera de un entorno que aplique el CORS en su navegador y si desea acceder a todos los servicios que proporciona el SDK JavaScript, puede crear una copia personalizada del SDK de forma local clonando el repositorio y ejecutando las mismas herramientas de compilación que crean la versión alojada predeterminada del SDK. En las siguientes secciones se describen los pasos necesarios para compilar el SDK con servicios adicionales y versiones de API.

Uso del SDK Builder para crear el SDK para JavaScript

La forma más sencilla de crear tu propia versión del AWS SDK for JavaScript es utilizar la aplicación web SDK Builder en https://sdk.amazonaws.com/builder/js. Utilice el compilador del SDK para especificar servicios y las versiones de API que se deben incluir en la compilación.

Elija Select all services (Seleccionar todos los servicios) o elija Select default services (Seleccionar servicios predeterminados) como punto de partida desde el que puede añadir o eliminar servicios. Elija Development (Desarrollo) para facilitar la lectura del código o elija Minified (Minimizado) para crear una compilación minimizada para la implementación. Después de elegir los servicios y las versiones que desea incluir, elija Build (Compilar) para compilar y descargar el SDK personalizado.

Uso de la CLI para crear el SDK para JavaScript

Para compilar el SDK para JavaScript usarlo AWS CLI, primero debes clonar el repositorio de Git que contiene la fuente del SDK. Debe tener Git y Node.js instalados en su equipo.

En primer lugar, clona el repositorio GitHub y cambia el directorio por el directorio:

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

Después de clonar el repositorio, descargue los módulos de dependencia para el SDK y la herramienta de compilación:

npm install

Ahora puede compilar una versión empaquetada del SDK.

Compilación desde la línea de comandos

La herramienta del compilador se encuentra en dist-tools/browser-builder.js. Ejecute este script escribiendo:

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

Este comando compila el archivo aws-sdk.js. Este archivo está sin comprimir. De forma predeterminada, este paquete contiene solo el conjunto de servicios estándar.

Minimización de la salida de la compilación

Para reducir la cantidad de datos en la red, JavaScript los archivos se pueden comprimir mediante un proceso denominado minificación. La minimización elimina comentarios, espacios innecesarios y otros caracteres que facilitan la lectura a las personas pero que no afectan a la ejecución del código. La herramienta del compilador puede producir salidas minimizadas o sin comprimir. Para minimizar la salida de la compilación, establezca la variable de entorno MINIFY:

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

Creación de servicios y versiones de API concretos

Puede seleccionar qué servicios desea compilar en el SDK. Para seleccionar servicios, especifique los nombres de los servicio, delimitados por comas, como si fueran parámetros. Por ejemplo, para compilar únicamente Amazon S3 y Amazon EC2, use el comando siguiente:

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

También puede seleccionar versiones de API específicas de los servicios compilados añadiendo el nombre de la versión después del nombre del servicio. Por ejemplo, para compilar las dos versiones de la API de Amazon DynamoDB, ejecute el comando siguiente:

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

Los identificadores de servicio y las versiones de la API están disponibles en los archivos de configuración específicos del servicio en https://github.com/aws/ /tree/master/apis. aws-sdk-js

Compilación de todos los servicios

Puede compilar todos los servicios y las versiones de la API incluyendo el parámetro all:

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

Compilación de servicios concretos

Para personalizar el conjunto de servicios seleccionados incluidos en la compilación, transfiera la variable de entorno AWS_SERVICES al comando Browserify que contiene la lista de servicios que quiere. El ejemplo siguiente compila los servicios Amazon EC2, Amazon S3 y DynamoDB.

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

Compilación del SDK como dependencia con Browserify

Node.js tiene un mecanismo basado en módulos para incluir código y funcionalidades de otros desarrolladores. Este enfoque modular no se admite de forma nativa si se ejecuta en navegadores web. JavaScript Sin embargo, con una herramienta llamada Browserify, puede utilizar el método de módulos Node.js y utilizar módulos escritos para Node.js en el navegador. Browserify crea las dependencias de los módulos de un script de navegador en un JavaScript archivo único e independiente que puede usar en el navegador.

Puede compilar el SDK como una dependencia de biblioteca para cualquier script de navegador usando Browserify. Por ejemplo, el siguiente código Node.js requiere el SDK:

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

Este código de ejemplo se puede compilar en una versión compatible con navegador mediante Browserify:

$ browserify index.js > browser-app.js

La aplicación, incluidas sus dependencias del SDK, pasa entonces a estar disponible en el navegador a través de browser-app.js.

Para obtener más información acerca de Browserify, consulte el sitio web de Browserify.