Especificación de cabeceras HTTP

Determinadas personalizaciones de solicitud necesitan que se establezcan cabeceras HTTP. Las cabeceras Content-Type y Accept controlan el formato de entrada y salida. La cabecera Range controla paginación. La cabecera Compression controla la compresión.

Cabeceras Content-Type y Accept

Para especificar los tipos de contenido del cuerpo de solicitud y la salida, utilice las cabeceras Content-Type y Accept.

Tabla 1. Valores de cabeceras Content-Type y Accept
Nombre de cabecera	Valor	Descripción
`Content-Type`	`application/json`	Indica que el formato de cuerpo de solicitud es JSON.
	`application/xml`	Indica que el formato de cuerpo de solicitud es XML.
	`application/x-www-form-urlencoded`	Indica que el cuerpo de solicitud está codificado en URL.
`Accept`	`application/json`	Establece el tipo de salida en JSON.
	`application/json;indent=2`	Establece el tipo de salida en JSON formateado.
	`application/xml`	Establece el tipo de salida en XML.

Rango

La cabecera Range controla la paginación en las llamadas de API List.

Tabla 2. Valores de cabecera Range
Nombre de cabecera	Valor	Descripción
`Range`	`items=x-y`	Devuelve registros con los ID de fila `x` a `y`. De forma alternativa, puede especificar el rango en el URL de la solicitud con el parámetro `_range=x-y`.

Compresión

Para comprimir los datos de una respuesta, establezca la cabecera Accept-Encoding

Tabla 3. Valores de cabecera Compression
Nombre de cabecera	Valor	Descripción
`Accept-Encoding`	`gzip`	Devuelve resultados comprimidos con formato .ZIP GNU.
`Accept-Encoding`	`identity`	Devuelve resultados con codificación de identidad (sin transformación).

X-HTTP-Method-Override

Si no puede utilizar un verbo HTTP en una solicitud, envíe una solicitud POST con el verbo como valor para la cabecera de sustitución. La solicitud se comporta como si la llamada se realizase con el verbo HTTP indicado en la cabecera de sustitución.

Por ejemplo, si no puede pasar una solicitud DELETE para el número de orden 12345, establezca la cabecera X-HTTP-Method-Override en DELETE y utilice la solicitud HTTP:

POST https://host:port/contextRoot/restapi/order/12345

También puede utilizar la cabecera X-HTTP-Method-Override para pasar parámetros en las solicitudes GET que superan el límite de tamaño de un URL. Realice un POST en el URL, establezca la cabecera Content-Type en application/x-www-form-urlencoded y establezca la cabecera X-HTTP-Method-Override en GET.

Tabla 4. Valores de cabecera X-HTTP-Method-Override
Nombre de cabecera	Valor
`X-HTTP-Method-Override`	`GET`
	`PATCH`
	`DELETE`