HATEOAS API - Revision history

Thexa4: /* Language Support */

2021-01-19T13:58:46Z

Language Support

← Older revision		Revision as of 06:58, 19 January 2021
Line 14:		Line 14:
	== Language Support ==		== Language Support ==
	Some programming languages have ready to use libraries that can help you implement a HATEOAS API:		Some programming languages have ready to use libraries that can help you implement a HATEOAS API:

	* [[HATEOAS API (Ruby) \| Ruby]]		* [[HATEOAS API (Ruby) \| Ruby]]
			* [[HATEOAS API (NodeJS) \| NodeJS]]

	== Comparison ==		== Comparison ==

Thexa4 at 13:52, 19 January 2021

2021-01-19T13:52:25Z

← Older revision		Revision as of 06:52, 19 January 2021
Line 11:		Line 11:
	* [[Content Negotiation]] to [[Backward Compatibility \| support older clients]] and [[Internationalization \| give users localized versions of resources]].		* [[Content Negotiation]] to [[Backward Compatibility \| support older clients]] and [[Internationalization \| give users localized versions of resources]].
	* Conditional PUTs to add [[Optimistic Concurrency]].		* Conditional PUTs to add [[Optimistic Concurrency]].

			== Language Support ==
			Some programming languages have ready to use libraries that can help you implement a HATEOAS API:
			* [[HATEOAS API (Ruby) \| Ruby]]

	== Comparison ==		== Comparison ==

Thexa4 at 01:44, 19 January 2021

2021-01-19T01:44:50Z

← Older revision		Revision as of 18:44, 18 January 2021
Line 5:		Line 5:
	* It does not allow clients to construct [[URL \| URLs]] (unless [[URL Templating \| instructed by the server to do so]]) to allow for applications to change their URL structure.		* It does not allow clients to construct [[URL \| URLs]] (unless [[URL Templating \| instructed by the server to do so]]) to allow for applications to change their URL structure.
	* Other than an entry URL and a set of documents describing the [[Media Types]], no additional knowledge should be necessary to use the API.		* Other than an entry URL and a set of documents describing the [[Media Types]], no additional knowledge should be necessary to use the API.
			* Having a nice URL structure is not essential, people in browsers will be clicking on links instead of typing and source code should only contain the root URL.

	HATEOAS APIs usually make heavy use of HTTP features like:		HATEOAS APIs usually make heavy use of HTTP features like:
Line 39:		Line 40:
	\|-		\|-
	\| [https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md Microsoft] \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes		\| [https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md Microsoft] \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes
			\|-
			\| [https://cloud.google.com/apis/design Google] \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes
	\|}		\|}

	[[Category: Terminology]]		[[Category: Terminology]]

Thexa4 at 01:33, 19 January 2021

2021-01-19T01:33:48Z

← Older revision		Revision as of 18:33, 18 January 2021
Line 37:		Line 37:
	\|-		\|-
	\| GraphQL \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No		\| GraphQL \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No
			\|-
			\| [https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md Microsoft] \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes
	\|}		\|}

	[[Category: Terminology]]		[[Category: Terminology]]

Thexa4 at 01:19, 19 January 2021

2021-01-19T01:19:24Z

← Older revision		Revision as of 18:19, 18 January 2021
Line 7:		Line 7:

	HATEOAS APIs usually make heavy use of HTTP features like:		HATEOAS APIs usually make heavy use of HTTP features like:
	* [[Caching]] to enable the application to [[Scaling \| scale better]].		* [[HTTP Caching \| Caching]] to enable the application to [[Scaling \| scale better]].
	* [[Content Negotiation]] to [[Backward Compatibility \| support older clients]] and [[Internationalization \| give users localized versions of resources]].		* [[Content Negotiation]] to [[Backward Compatibility \| support older clients]] and [[Internationalization \| give users localized versions of resources]].
	* Conditional PUTs to add [[Optimistic Concurrency]].		* Conditional PUTs to add [[Optimistic Concurrency]].

Thexa4: Style

2021-01-14T19:51:04Z

Style

← Older revision		Revision as of 12:51, 14 January 2021
Line 14:		Line 14:
	{\| class="wikitable sortable"		{\| class="wikitable sortable"
	\|-		\|-
	! Method		! style="background-position: center bottom;padding-right: 0;padding-bottom:21px" \| Method
	!! style="writing-mode: vertical-rl;" \| Browser Accessible		!! style="writing-mode: vertical-rl; background-position: center bottom;padding-right: 0;padding-bottom:21px" \| Browser Accessible
	!! style="writing-mode: vertical-rl;" \| Backward Compatible		!! style="writing-mode: vertical-rl; background-position: center bottom;padding-right: 0;padding-bottom:21px" \| Backward Compatible
	!! style="writing-mode: vertical-rl;" \| Backward Compatible (default)		!! style="writing-mode: vertical-rl; background-position: center bottom;padding-right: 0;padding-bottom:21px" \| Backward Compatible (default)
	!! style="writing-mode: vertical-rl;" \| HTTP Cachable		!! style="writing-mode: vertical-rl; background-position: center bottom;padding-right: 0;padding-bottom:21px" \| HTTP Cachable
	!! style="writing-mode: vertical-rl;" \| No URL Construction		!! style="writing-mode: vertical-rl; background-position: center bottom;padding-right: 0;padding-bottom:21px" \| No URL Construction
	!! style="writing-mode: vertical-rl;" \| URL as Identifier		!! style="writing-mode: vertical-rl; background-position: center bottom;padding-right: 0;padding-bottom:21px" \| URL as Identifier
	!! style="writing-mode: vertical-rl;" \| Stable Pagination		!! style="writing-mode: vertical-rl; background-position: center bottom;padding-right: 0;padding-bottom:21px" \| Stable Pagination
	!! style="writing-mode: vertical-rl;" \| Concurrency Support		!! style="writing-mode: vertical-rl; background-position: center bottom;padding-right: 0;padding-bottom:21px" \| Concurrency Support
	\|-		\|-
	\| HATEOAS \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes		\| HATEOAS \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes

Thexa4: /* Comparison */

2021-01-14T18:12:51Z

Comparison

← Older revision		Revision as of 11:12, 14 January 2021
Line 30:		Line 30:
	\| [https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api Github] (REST) \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No		\| [https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api Github] (REST) \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No
	\|-		\|-
	\| [https://opensource.zalando.com/restful-api-guidelines/#114 Zalando] \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#~~fdffb6~~"\|? \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes		\| [https://opensource.zalando.com/restful-api-guidelines/#114 Zalando] \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes
	\|-		\|-
	\| [https://developers.facebook.com/docs/graph-api/overview Facebook Graph API] \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#fdffb6"\|? \|\| style="background:#ffadad"\|No		\| [https://developers.facebook.com/docs/graph-api/overview Facebook Graph API] \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#fdffb6"\|? \|\| style="background:#ffadad"\|No

Thexa4: Add Concurrency Support

2021-01-14T18:04:17Z

Add Concurrency Support

← Older revision		Revision as of 11:04, 14 January 2021
Line 22:		Line 22:
	!! style="writing-mode: vertical-rl;" \| URL as Identifier		!! style="writing-mode: vertical-rl;" \| URL as Identifier
	!! style="writing-mode: vertical-rl;" \| Stable Pagination		!! style="writing-mode: vertical-rl;" \| Stable Pagination
			!! style="writing-mode: vertical-rl;" \| Concurrency Support
	\|-		\|-
	\| HATEOAS \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#fdffb6"\|?		\| HATEOAS \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes
	\|-		\|-
	\| [https://github.com/XPBytes/media_types-serialization media_types-serialization] (HATEOAS) \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes		\| [https://github.com/XPBytes/media_types-serialization media_types-serialization] (HATEOAS) \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#fdffb6"\|?
	\|-		\|-
	\| [https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api Github] (REST) \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes		\| [https://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api Github] (REST) \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No
	\|-		\|-
	\| [https://opensource.zalando.com/restful-api-guidelines/#114 Zalando] \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes		\| [https://opensource.zalando.com/restful-api-guidelines/#114 Zalando] \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes
	\|-		\|-
	\| [https://developers.facebook.com/docs/graph-api/overview Facebook Graph API] \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#fdffb6"\|?		\| [https://developers.facebook.com/docs/graph-api/overview Facebook Graph API] \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#fdffb6"\|? \|\| style="background:#ffadad"\|No
	\|-		\|-
	\| [https://shopify.dev/docs/admin-api/rest Shopify] (REST) \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes		\| [https://shopify.dev/docs/admin-api/rest Shopify] (REST) \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No
	\|-		\|-
	\| GraphQL \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes		\| GraphQL \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No
	\|}		\|}

	[[Category: Terminology]]		[[Category: Terminology]]

Thexa4: /* Comparison */

2021-01-14T18:00:45Z

Comparison

← Older revision		Revision as of 11:00, 14 January 2021
Line 34:		Line 34:
	\|-		\|-
	\| [https://shopify.dev/docs/admin-api/rest Shopify] (REST) \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes		\| [https://shopify.dev/docs/admin-api/rest Shopify] (REST) \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes
			\|-
			\| GraphQL \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes
	\|}		\|}

	[[Category: Terminology]]		[[Category: Terminology]]

Thexa4: Add Shopify

2021-01-14T17:58:01Z

Add Shopify

← Older revision		Revision as of 10:58, 14 January 2021
Line 31:		Line 31:
	\| [https://opensource.zalando.com/restful-api-guidelines/#114 Zalando] \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes		\| [https://opensource.zalando.com/restful-api-guidelines/#114 Zalando] \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes
	\|-		\|-
	\| [https://developers.facebook.com/docs/graph-api/overview Facebook Graph API] \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#~~fdffb6~~"\|?		\| [https://developers.facebook.com/docs/graph-api/overview Facebook Graph API] \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#fdffb6"\|?
			\|-
			\| [https://shopify.dev/docs/admin-api/rest Shopify] (REST) \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#ffadad"\|No \|\| style="background:#caffbf"\|Yes
	\|}		\|}

	[[Category: Terminology]]		[[Category: Terminology]]

← Older revision		Revision as of 12:51, 14 January 2021
Line 14:		Line 14:
	{\| class="wikitable sortable"		{\| class="wikitable sortable"
	\|-		\|-
	! Method		! style="background-position: center bottom;padding-right: 0;padding-bottom:21px" \| Method
	!! style="writing-mode: vertical-rl;" \| Browser Accessible		!! style="writing-mode: vertical-rl; background-position: center bottom;padding-right: 0;padding-bottom:21px" \| Browser Accessible
	!! style="writing-mode: vertical-rl;" \| Backward Compatible		!! style="writing-mode: vertical-rl; background-position: center bottom;padding-right: 0;padding-bottom:21px" \| Backward Compatible
	!! style="writing-mode: vertical-rl;" \| Backward Compatible (default)		!! style="writing-mode: vertical-rl; background-position: center bottom;padding-right: 0;padding-bottom:21px" \| Backward Compatible (default)
	!! style="writing-mode: vertical-rl;" \| HTTP Cachable		!! style="writing-mode: vertical-rl; background-position: center bottom;padding-right: 0;padding-bottom:21px" \| HTTP Cachable
	!! style="writing-mode: vertical-rl;" \| No URL Construction		!! style="writing-mode: vertical-rl; background-position: center bottom;padding-right: 0;padding-bottom:21px" \| No URL Construction
	!! style="writing-mode: vertical-rl;" \| URL as Identifier		!! style="writing-mode: vertical-rl; background-position: center bottom;padding-right: 0;padding-bottom:21px" \| URL as Identifier
	!! style="writing-mode: vertical-rl;" \| Stable Pagination		!! style="writing-mode: vertical-rl; background-position: center bottom;padding-right: 0;padding-bottom:21px" \| Stable Pagination
	!! style="writing-mode: vertical-rl;" \| Concurrency Support		!! style="writing-mode: vertical-rl; background-position: center bottom;padding-right: 0;padding-bottom:21px" \| Concurrency Support
	\|-		\|-
	\| HATEOAS \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes		\| HATEOAS \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#caffbf"\|Yes \|\| style="background:#fdffb6"\|? \|\| style="background:#caffbf"\|Yes