

# Habilitación de la compresión de la carga para una API en API Gateway
<a name="api-gateway-enable-compression"></a>

Puede habilitar la compresión de una API mediante la consola de API Gateway, la AWS CLI o un AWS SDK.

En el caso de una API existente, debe implementar la API después de habilitar la compresión para que el cambio surta efecto. Para una nueva API, puede implementar la API después de que se haya completado la configuración de la API.

**nota**  
La codificación de contenido de mayor prioridad debe ser una compatible con la API Gateway. Si no es así, la compresión no se aplica a la carga de la respuesta.

**Topics**
+ [Habilitación de la compresión de la carga en una API a través de la consola de API Gateway](#api-gateway-enable-compression-console)
+ [Habilitación de la compresión de carga en una API a través de la AWS CLI](#api-gateway-enable-compression-cli)
+ [Codificaciones de contenido admitidas por API Gateway](#api-gateway-supported-content-encodings)

## Habilitación de la compresión de la carga en una API a través de la consola de API Gateway
<a name="api-gateway-enable-compression-console"></a>

En el siguiente procedimiento, se describe cómo habilitar la compresión de la carga en una API. 

**Para habilitar la compresión de carga a través de la consola de API Gateway**

1. Inicie sesión en la consola de API Gateway, en [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).

1. Seleccione una API existente o cree una nueva.

1. En el panel de navegación principal, elija **Configuración de la API**. 

1. En la sección **Detalles de la API**, elija **Editar**.

1. Active la **codificación de contenido** para habilitar la compresión de carga. En **Tamaño mínimo del cuerpo**, ingrese un número para el tamaño mínimo de compresión (en bytes). Para desactivar la compresión, desactive la opción **codificación de contenido**.

1. Elija **Guardar cambios**.

## Habilitación de la compresión de carga en una API a través de la AWS CLI
<a name="api-gateway-enable-compression-cli"></a>



El siguiente comando [create-rest-api](https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-rest-api.html) permite crear una API con compresión de la carga útil:

```
aws apigateway create-rest-api \
    --name "My test API" \
    --minimum-compression-size 0
```

El siguiente comando [update-rest-api](https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-rest-api.html) permite habilitar la compresión de la carga útil para una API existente:

```
aws apigateway update-rest-api \
    --rest-api-id 1234567890 \
    --patch-operations op=replace,path=/minimumCompressionSize,value=0
```

La propiedad `minimumCompressionSize` presenta un valor entero no negativo entre 0 y 10485760 (10 megabytes). Mide el umbral de compresión. Si el tamaño de la carga es menor que este valor, la compresión o la descompresión no se aplican en la carga. Si se establece en cero, la compresión está permitida para cualquier tamaño de carga.

El siguiente comando [update-rest-api](https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-rest-api.html) permite desactivar la compresión de la carga útil:

```
aws apigateway update-rest-api \
    --rest-api-id 1234567890 \
    --patch-operations op=replace,path=/minimumCompressionSize,value=
```

También puede definir `value` en una cadena vacía `""` u omitir la propiedad `value` en su conjunto en la llamada anterior.

## Codificaciones de contenido admitidas por API Gateway
<a name="api-gateway-supported-content-encodings"></a>

API Gateway admite las siguientes codificaciones de código:
+ `deflate`
+ `gzip`
+ `identity`

API Gateway también admite el siguiente formato de encabezado `Accept-Encoding`, conforme a la especificación [RFC 7231](https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.4):
+ `Accept-Encoding:deflate,gzip`
+ `Accept-Encoding:`
+ `Accept-Encoding:*`
+ `Accept-Encoding:deflate;q=0.5,gzip;q=1.0`
+ `Accept-Encoding:gzip;q=1.0,identity;q=0.5,*;q=0`