rest/brainstorming - Revision history

RyanKing: Reverted edits by GetmoNtroc (Talk) to last version by JasonK

2009-01-04T20:12:29Z

Reverted edits by GetmoNtroc (Talk) to last version by JasonK

← Older revision		Revision as of 20:12, 4 January 2009
Line 1:		Line 1:
	~~rolrotrb~~
	= XHTML-REST Brainstorming =		= XHTML-REST Brainstorming =

GetmoNtroc: chitrerlibas

2009-01-04T00:56:32Z

chitrerlibas

← Older revision		Revision as of 00:56, 4 January 2009
Line 1:		Line 1:
			rolrotrb
	= XHTML-REST Brainstorming =		= XHTML-REST Brainstorming =

JasonK: /* Constraints */

2007-01-10T20:27:51Z

Constraints

← Older revision		Revision as of 20:27, 10 January 2007
Line 13:		Line 13:
	** XOXT: [[table-brainstorms]] (table-th-tr-td)		** XOXT: [[table-brainstorms]] (table-th-tr-td)
	* All URI links must be encoded as either:		* All URI links must be encoded as either:
	** Anchors (<a&rt;) (via 'href')		** Anchors (<a>) (via 'href')
	** Forms (<a&rt;) (via 'action')		** Forms (<a>) (via 'action')
	* Only GET and POST actions are supported		* Only GET and POST actions are supported

Line 25:		Line 25:
	or, put another way:		or, put another way:
	* 80% x 80% x 80% = 51.2% of the benefit for		* 80% x 80% x 80% = 51.2% of the benefit for
	* 20% x 20% x 20% = 0.8% of the effort		* 20% x 20% x 20% = 0.8% of the effort

	== Conventions ==		== Conventions ==

OlaBerg: /* See Also */

2006-10-09T14:13:58Z

OlaBerg: /* Forms Design Pattern */

2006-10-09T14:11:49Z

Forms Design Pattern

← Older revision		Revision as of 14:11, 9 October 2006
Line 93:		Line 93:
	=== Forms Design Pattern ===		=== Forms Design Pattern ===

			I use a number of <form>s to declare the API for a web resource:

			<div class="function">
			<h1>Foobalize</h1>

			<p>Foobalizer foobalizes grunts and glomph. Note that blorks already must be gazzed!
			</p>

			<form action="GET" action="http://www.example.com/glurt">
			<div class="field">
			<label for="grunt">Grunt</label> <input type="text" class="varchar(20)" />
			</div>
			<div class="field">
			<label for="grunt">Blork</label> <input type="text" class="int4" />
			</div>
			<input type="submit" value="Foobalize" />
			</form>

			</div>

	== See Also ==		== See Also ==

DimitriGlazkov: /* Verbs */

2005-10-20T02:14:03Z

Verbs

← Older revision		Revision as of 02:14, 20 October 2005
Line 46:		Line 46:
	REST depends on using verbs properly. Your typical verbs are POST (create), GET (retrieve), PUT (update), and DELETE (delete). More verbs can be defined and used, but the listed above are most commonly used and supported.		REST depends on using verbs properly. Your typical verbs are POST (create), GET (retrieve), PUT (update), and DELETE (delete). More verbs can be defined and used, but the listed above are most commonly used and supported.

	As we know, HTML forms spec (and therefore commonly used UAs) only provides support for POST and GET verbs. This limitation has been the biggest argument against mixing HTML and REST: tunnelling of PUT and DELETE verbs through POST (or even worse, GET) creates architectural unREST.		As we know, HTML forms spec (and therefore commonly used UAs) only provides support for POST and GET verbs. This limitation has been the biggest argument against mixing HTML and REST: tunnelling of PUT and DELETE verbs through POST (or even worse, GET) creates architectural unREST.

	However, some architectures simply do not need deletion and update operations. Using HTML with REST requires employing such architectures.		However, some architectures simply do not need deletion and update operations. Using HTML with REST requires employing such architectures.
Line 66:		Line 66:
	GET record?view=edit # encode as hyperlinks/anchors		GET record?view=edit # encode as hyperlinks/anchors
	GET record?view=api # encode as hyperlinks/anchors + descriptions		GET record?view=api # encode as hyperlinks/anchors + descriptions
	POST record?update # update record		POST record?update # update record -- this is tunnelling, a no-no

	For simplicity, we assume:		For simplicity, we assume:

DimitriGlazkov: /* Verbs */

2005-10-20T02:11:24Z

Verbs

← Older revision		Revision as of 02:11, 20 October 2005
Line 46:		Line 46:
	REST depends on using verbs properly. Your typical verbs are POST (create), GET (retrieve), PUT (update), and DELETE (delete). More verbs can be defined and used, but the listed above are most commonly used and supported.		REST depends on using verbs properly. Your typical verbs are POST (create), GET (retrieve), PUT (update), and DELETE (delete). More verbs can be defined and used, but the listed above are most commonly used and supported.

	As we know, HTML forms spec (and therefore commonly used UAs) only provides support POST and GET verbs. This limitation has been the biggest argument against mixing HTML and REST: tunnelling of PUT and DELETE verbs through POST (or even worse, GET) creates architectural unREST.		As we know, HTML forms spec (and therefore commonly used UAs) only provides support for POST and GET verbs. This limitation has been the biggest argument against mixing HTML and REST: tunnelling of PUT and DELETE verbs through POST (or even worse, GET) creates architectural unREST.

	However, some architectures simply do not need deletion and update operations. Using HTML with REST requires employing such architectures.		However, some architectures simply do not need deletion and update operations. Using HTML with REST requires employing such architectures.

DimitriGlazkov: /* Verbs */

2005-10-20T02:10:48Z

Verbs

← Older revision		Revision as of 02:10, 20 October 2005
Line 44:		Line 44:
	=== Verbs ===		=== Verbs ===

	~~Even though~~ REST ~~allows four possible HTTP actions~~ (GET~~, POST~~, PUT, and DELETE) we only ~~use two~~: GET ~~& POST~~, ~~for compatibility~~ with ~~existing web clients~~. While that may seem overly restrictive, as a practical matter those cover the "80%" of public web services we are trying to solve (after all, you are welcome to use your own private methods if you need to).		REST depends on using verbs properly. Your typical verbs are POST (create), GET (retrieve), PUT (update), and DELETE (delete). More verbs can be defined and used, but the listed above are most commonly used and supported.

			As we know, HTML forms spec (and therefore commonly used UAs) only provides support POST and GET verbs. This limitation has been the biggest argument against mixing HTML and REST: tunnelling of PUT and DELETE verbs through POST (or even worse, GET) creates architectural unREST.

			However, some architectures simply do not need deletion and update operations. Using HTML with REST requires employing such architectures.

			While that may seem overly restrictive, as a practical matter those cover the "80%" of public web services we are trying to solve (after all, you are welcome to use your own private methods if you need to).

	Even better, we can define very precise semantics for what GET & POST mean for each of the different nouns:		Even better, we can define very precise semantics for what GET & POST mean for each of the different nouns:

DrErnie: /* See Also */

2005-10-18T11:09:21Z

DrErnie: /* See Also */

2005-10-15T05:28:58Z

← Older revision		Revision as of 11:09, 18 October 2005
Line 92:		Line 92:
	* [http://www.opendarwin.org/~drernie/rest-api.html REST self-describing API proposal]		* [http://www.opendarwin.org/~drernie/rest-api.html REST self-describing API proposal]
	* [http://opensearch.a9.com/ OpenSearch search results standard (REST-like)]		* [http://opensearch.a9.com/ OpenSearch search results standard (REST-like)]
	* [[rest-brainstorming]]
	* [[rest-proposal-preso]]		* [[rest-proposal-preso]]
			* [[duhper-proposal-preso]]

	[http://www.opendarwin.org/~drernie/rest-api.html Proposed REST API]		[http://www.opendarwin.org/~drernie/rest-api.html Proposed REST API]

← Older revision		Revision as of 05:28, 15 October 2005
Line 93:		Line 93:
	* [http://opensearch.a9.com/ OpenSearch search results standard (REST-like)]		* [http://opensearch.a9.com/ OpenSearch search results standard (REST-like)]
	* [[rest-brainstorming]]		* [[rest-brainstorming]]
	* [[rest-~~overview~~]]		* [[rest-proposal-preso]]

	[http://www.opendarwin.org/~drernie/rest-api.html Proposed REST API]		[http://www.opendarwin.org/~drernie/rest-api.html Proposed REST API]

← Older revision		Revision as of 14:13, 9 October 2006
Line 96:		Line 96:

	<div class="function">		<div class="function">
			The visual human name in h1-tags:

	<h1>Foobalize</h1>		<h1>Foobalize</h1>

			A human readable explanation using in some html.

	<p>Foobalizer foobalizes grunts and glomph. Note that blorks already must be gazzed!		<p>Foobalizer foobalizes grunts and glomph. Note that blorks already must be gazzed!
	</p>		</p>

	<form action="GET" action="http://www.example.com/glurt">		Then the form that specifies one function:

			<form id="fooblize" action="GET" action="http://www.example.com/glurt">
	<div class="field">		<div class="field">
	<label for="grunt">Grunt</label> <input type="text" class="varchar(20)" />		<label for="grunt">Grunt</label> <input type="text" class="varchar(20)" />