Runtime открытия гипермедиа HATEOAS?

Question

Я понимаю, что HATEOAS представляет состояние приложений, отправив все действия, которые могут быть выполнены в тот момент времени в приложении в качестве ответа (HAL, JSON-LD и т. Д.).

Например, просмотр ресурса учетной записи банка может позволить вам внести, снять или закрыть учетную запись (ОПЦИИ, которые могут возвращать UPDATE и DELETE).

С точки зрения обнаружения во время выполнения этих ссылок (по потребляющему клиенту), как это можно сделать?

Если целью отправки этих ссылок является развязка клиента с сервера и управление состоянием гипермедиа в ответе, должно быть количество знаний, которые разработчик должен жестко кодировать в приложении, чтобы иметь смысл возвращаемых ответов.

Я понимаю, что отправка запросов OPTIONS - это способ определить текущее состояние ресурса и что вы можете сделать дальше, но для того, чтобы обнаружить фактические URI для использования - будут ли они просто жестко закодированы как URI COOL?

Answer 1

Здесь есть куча предшествующего уровня техники, пытаясь создать выразительную, открываемую гипермедиа. Вы можете просмотреть:

• http://json-ld.org/
• http://www.markus-lanthaler.com/hydra/

Я имею в виду, может быть серию, если заявления, который проверяет наличие определенных свойств для определения состояния или, может быть, даже переключаться заявления. Это правильный путь - или есть ли лучшее средство для обнаружения гипермедиа?

Мое настоящее мышление заключается в том, что вы хотите, чтобы ваши идеи больше формировались в соответствии с принципами переговоров и соблюдения протокола; так что думайте, что машина, а не заявления.

Для начала ознакомьтесь с. How To GET a Cup of Coffee.

Гиперссылки в документах, обслуживаемых RESTBucks, предназначены для помощи клиенту в согласовании протокола RESTBucks; предположение, что клиент уже понимает, что протокол выпекается в модель. Другими словами, клиент уже понимает, что переговоры по протоколу позволят ему достичь goal.

Конечно, может быть несколько протоколов, которые служат одной и той же цели. Например, RESTBucks также может поддерживать протокол «Подавать старый кофе»; объявив о присутствии каждого, ожидается, что клиент будет выбирать, что является лучшим выражением цели, и следовать этому пути.

Answer 2

Как и @VoicesOfUnreason, в URI HATEOAS можно обнаружить (и не задокументировать), чтобы их можно было изменить. То есть, если они не являются самыми точками входа в вашу систему (Cool URIs, единственные, которые могут быть жестко закодированы клиентами) - и у вас не должно быть слишком многих из них, если вы хотите, чтобы развилась остальная часть вашей система URI системы в будущем. Это фактически одна из самых useful функций REST.

Для оставшихся не-Cool URI они могут быть изменены с течением времени, и ваша документация по API должна содержать информацию о том, что они должны быть обнаружены во время выполнения через обход гипермедиа.

Глядя на Richardson's Maturity Model (level 3), это будет где ссылки вступают в игру. Например, с верхнего уровня, say/api/version (/ 1), вы обнаружите, что есть ссылка на группы. Вот как это может выглядеть в инструменте, как HAL Browser:

Корень:

{ 
    "_links": { 
    "self": { 
     "href": "/api/root" 
    }, 
    "api:group-add": { 
     "href": "http://apiname:port/api/group" 
    }, 
    "api:group-search": { 
     "href": "http://apiname:port/api/group?pageNumber={pageNumber}&pageSize={pageSize}&sort={sort}" 
    }, 
    "api:group-by-id": { 
     "href": "http://apiname:port/api/group/id" (OR "href": "http://apiname:port/api/group?id={id}") 
    } 
    } 
} 

Надстройка будет просто POST к этой конечной точке, и тогда вам придется 2 метода GET.

GET /api/group?pageNumber=0&pageSize=20&sort=asc

, которые могли бы вернуть что-то вроде этого:

{ 
    "groups": [ 
     { 
     "id": 123, 
     "name": "Test Group" 
     }, 
     { 
     "id": 134, 
     "name": "Tennis squad" 
     } 
    ] 
} 

Затем, когда вы перейти к определенной группе (например # 123):

{ 
    "Id" : 123, 
    "Name" : "test", 
    "_links": { 
    "self": { 
     "href": "/api/group/1" (OR "/api/group?id=1") 
    }, 
    "edit": { 
     "href": "http://apiname:port/api/group/1" 
    }, 
    "api:delete": { 
     "href": "http://apiname:port/api/group/1" 
    }, 
    "api:items-query": { 
     "href": "http://apiname:port/api/bonus?groupId=1" 
    } 
    } 
} 

Здесь редактировать бы просто введите PUT, а затем вам понадобится DELETE (см. уровень 2 REST в той же самой ссылке), так как для элементов вы, вероятно, знаете лучше всего, если они просто свойство, или другой конец т; вы можете включить их для возврата в том же вызове, который извлекает группу.

Преимущество здесь состояло в том, что клиенту нужно было бы знать только имя отношения (ссылка) (очевидно, помимо структуры/свойств ресурса), тогда как сервер будет в основном свободным изменять URL-адрес отношения (и ресурса) ,