Lenguaje de aplicación de hipertexto

El lenguaje de aplicación de hipertexto ( HAL ) es una convención para definir hipermedia , como enlaces a recursos externos, dentro de código JSON o XML . Está documentado en un borrador de Internet (un "trabajo en progreso"), cuya última versión, la 11, se publicó el 10 de octubre de 2023. El estándar se propuso inicialmente en junio de 2012, específicamente para su uso con JSON, ^{[ 1 ]} y desde entonces está disponible en dos variantes: JSON y XML. Los dos tipos MIME asociados son application/hal+xml y application/hal+json. ^{[ 2 ]}

HAL se creó para ser sencillo de usar y fácilmente aplicable en diferentes ámbitos , evitando la necesidad de imponer requisitos sobre la estructura del proyecto. Gracias a este enfoque de mínimo impacto, HAL ha permitido a los desarrolladores crear bibliotecas de propósito general que pueden incorporarse a cualquier API que utilice HAL.

Las API que adoptan HAL simplifican el uso de bibliotecas de código abierto y permiten interactuar con la API mediante JSON o XML. La alternativa sería tener que desarrollar un formato propietario, lo que a su vez obligaría a los desarrolladores a aprender a usar otro formato ajeno. ^{[ 3 ]}

HAL está estructurado de tal manera que representa elementos basados ​​en dos conceptos: Recursos y Enlaces. Los Recursos consisten en enlaces URI , recursos incrustados, datos estándar (ya sean JSON o XML) y enlaces que no son URI. Los Enlaces tienen un URI de destino, así como el nombre del enlace (denominado 'rel'), y propiedades opcionales diseñadas para tener en cuenta la obsolescencia y la negociación de contenido. ^{[ 3 ]}

Recursos generales

{ "_links" : { "self" : { "href" : "http://example.com/api/book/hal-cookbook" } }, "id" : "hal-cookbook" , "name" : "HAL Cookbook" }

Recurso incrustado

{ "_links" : { "self" : { "href" : "http://example.com/api/book/hal-cookbook" } }, "_embedded" : { "author" : { "_links" : { "self" : { "href" : "http://example.com/api/author/shahadat" } }, "id" : "shahadat" , "name" : "Shahadat Hossain Khan" , "homepage" : "http://author-example.com" } }, "id" : "hal-cookbook" , "name" : "HAL Cookbook" }

Colecciones

{ "_links" : { "self" : { "href" : "http://example.com/api/book/hal-cookbook" }, "next" : { "href" : "http://example.com/api/book/hal-case-study" }, "prev" : { "href" : "http://example.com/api/book/json-and-beyond" }, "first" : { "href" : "http://example.com/api/book/catalog" }, "last" : { "href" : "http://example.com/api/book/upcoming-books" } }, "_embedded" : { "author" : { "_links" : { "self" : { "href" : "http://example.com/api/author/shahadat" } }, "id" : "shahadat" , "nombre" : "Shahadat Hossain Khan" , "página de inicio" : "http://author-example.com" } }, "id" : "hal-cookbook" , "nombre" : "HAL Cookbook" }

• ODIO
• CURIE (o URI compacta )

• Último borrador del lenguaje de aplicación de hipertexto JSON