Hypertextový aplikační jazyk - Hypertext Application Language

Hypertextový aplikační jazyk (HAL) je Koncept internetu („probíhající práce“) standardní konvence pro definování hypermediální například odkazy na externí zdroje v rámci JSON nebo XML kód (upozorňujeme však, že platnost nejnovější verze konceptu HAL Internet Draft vypršela 12. listopadu 2016.). Standard byl původně navržen v červnu 2012 konkrétně pro použití s ​​JSON[1] a od té doby je k dispozici ve dvou variantách, JSON a XML. Dva spojené MIM typy jsou typ média: aplikace / hal + xml a typ média: aplikace / hal + json.[2]

HAL byl vytvořen tak, aby byl snadno použitelný a snadno použitelný napříč různými domén vyhýbáním se nutnosti klást jakékoli požadavky na strukturu projektu. Díky zachování tohoto přístupu s minimálním dopadem umožnil HAL vývojářům vytvářet obecné účely knihovny které lze snadno začlenit do libovolného API který používá HAL.[Citace je zapotřebí ]

API, která přijímají HAL, zjednodušují použití otevřený zdroj knihovny a umožnit interakci s knihovnami API pomocí JSON nebo XML. Alternativou by bylo vyvinout a proprietární formát což zase nutí vývojáře naučit se používat ještě další cizí formát.[3]

Konvence

HAL je strukturován tak, aby představoval prvky založené na dvou koncepcích: Zdroje a Odkazy. Zdroje se skládají z URI odkazy, vložené zdroje, vaše standardní data (ať už JSON nebo XML) a odkazy bez URI. Odkazy mají cílový identifikátor URI, stejně jako název odkazu (označovaný jako „rel“) a také volitelné vlastnosti, které jsou navrženy tak, aby pamatovaly na zastarání a vyjednávání obsahu.[3]

Příklad

Obecný zdroj

{  "_Odkazy": {    "já": {      "href": „http://example.com/api/book/hal-cookbook“    }  },  „id“: „hal-kuchařka“,  "název": „HAL kuchařka“}

Vložený prostředek

{  "_Odkazy": {    "já": {      "href": „http://example.com/api/book/hal-cookbook“    }  },  „_embedded“: {    "autor": {      "_Odkazy": {        "já": {          "href": „http://example.com/api/author/shahadat“        }      },      „id“: "shahadat",      "název": „Shahadat Hossain Khan“,      "domovská stránka": „http://author-example.com“    }  },  „id“: „hal-kuchařka“,  "název": „HAL kuchařka“}

Sbírky

{  "_Odkazy": {    "já": {      "href": „http://example.com/api/book/hal-cookbook“    },    "další": {      "href": „http://example.com/api/book/hal-case-study“    },    "předchozí": {      "href": „http://example.com/api/book/json-and-beyond“    },    "za prvé": {      "href": „http://example.com/api/book/catalog“    },    "poslední": {      "href": „http://example.com/api/book/upcoming-books“    }  },  „_embedded“: {    "autor": {      "_Odkazy": {        "já": {          "href": „http://example.com/api/author/shahadat“        }      },      „id“: "shahadat",      "název": „Shahadat Hossain Khan“,      "domovská stránka": „http://author-example.com“    }  },  „id“: „hal-kuchařka“,  "název": „HAL kuchařka“}

Viz také

Reference

  1. ^ Kelly, Mike (7. června 2012). „Hypertextový aplikační jazyk JSON“. IETF. Citováno 16. října 2018.
  2. ^ Richardson, Leonard; Ruby, Mike Amundsen; předmluva Sama (2013). „7“. RESTful Web API (První vydání). Sebastopol, CA: O'Reilly. ISBN  978-1-4493-5806-8.
  3. ^ A b Kelly, Mike (13.06.2011). „HAL - Hypertext Application Language A lean hypermedia type“. Citováno 23. července 2014.

externí odkazy