API Guidelines - Revision history

Thexa4 at 17:03, 14 January 2021

2021-01-14T17:03:23Z

← Older revision		Revision as of 10:03, 14 January 2021
Line 8:		Line 8:
	* [[Media Types]] should have a description of the format to expect as well as the interactions you can make when you're viewing that resource.		* [[Media Types]] should have a description of the format to expect as well as the interactions you can make when you're viewing that resource.
	* The API should be explorable using a web browser.		* The API should be explorable using a web browser.
			* The API should be implemented in an [[Offensive Coding]] style, it should complain loudly when it receives something it did not expect.

Thexa4 at 15:57, 14 January 2021

2021-01-14T15:57:43Z

← Older revision		Revision as of 08:57, 14 January 2021
Line 3:		Line 3:
	* Resources should use [[HTTP Caching]].		* Resources should use [[HTTP Caching]].
	* Relationships between resources should be modeled using [[Link Header \| links]].		* Relationships between resources should be modeled using [[Link Header \| links]].
	* Updates to resources should use [[Optimistic Concurrency]] using [[ETag \| ETags]].		* Updates to resources should use [[Optimistic Concurrency]] using [[ETag Header \| ETags]].
	* GET, DELETE and PUT must be [[idempotent]].		* GET, DELETE and PUT must be [[idempotent]].
	* [[Pagination]] should use absolute ids for offset calculation instead of relative to the first page.		* [[Pagination]] should use absolute ids for offset calculation instead of relative to the first page.
	* [[Media Types]] should have a description of the format to expect as well as the interactions you can make when you're viewing that resource.		* [[Media Types]] should have a description of the format to expect as well as the interactions you can make when you're viewing that resource.
	* The API should be explorable using a web browser.		* The API should be explorable using a web browser.

Thexa4: Thexa4 moved page Guidelines to API Guidelines without leaving a redirect

2020-12-03T17:12:55Z

Thexa4 moved page Guidelines to API Guidelines without leaving a redirect

← Older revision	Revision as of 10:12, 3 December 2020
(No difference)

Thexa4 at 16:33, 30 November 2020

2020-11-30T16:33:00Z

← Older revision		Revision as of 09:33, 30 November 2020
Line 7:		Line 7:
	* [[Pagination]] should use absolute ids for offset calculation instead of relative to the first page.		* [[Pagination]] should use absolute ids for offset calculation instead of relative to the first page.
	* [[Media Types]] should have a description of the format to expect as well as the interactions you can make when you're viewing that resource.		* [[Media Types]] should have a description of the format to expect as well as the interactions you can make when you're viewing that resource.
			* The API should be explorable using a web browser.

Thexa4: Created page with "* Clients must never construct URLs without a template. * Versioning should be done using Content Type Negotiation. * Resources should use HTTP..."

2020-11-30T16:32:32Z

Created page with "* Clients must never construct URLs without a template. * Versioning should be done using Content Type Negotiation. * Resources should use HTTP..."

New page

* Clients must never construct URLs without a [[URL Templating | template]].
* [[Versioning]] should be done using [[Content Type Negotiation]].
* Resources should use [[HTTP Caching]].
* Relationships between resources should be modeled using [[Link Header | links]].
* Updates to resources should use [[Optimistic Concurrency]] using [[ETag | ETags]].
* GET, DELETE and PUT must be [[idempotent]].
* [[Pagination]] should use absolute ids for offset calculation instead of relative to the first page.
* [[Media Types]] should have a description of the format to expect as well as the interactions you can make when you're viewing that resource.