1,633
edits
URI DEV: Difference between revisions
m
no edit summary
m (→General: Fix typos) |
mNo edit summary |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{TOCright}} | {{TOCright}} | ||
==General== | ==General== | ||
The current URI system is a mess made up of different sets of parameters for the same purpose depending on who and when wrote something. The idea is to first to remove unnecessary stuff from it, second standardize parameter and third make it richer in feature | The current URI system is a mess made up of different sets of parameters for the same purpose depending on who and when wrote something. The idea is to first to remove unnecessary stuff from it, second standardize parameter and third make it richer in feature | ||
| Line 10: | Line 11: | ||
* help visualize the site structure | * help visualize the site structure | ||
* are short | * are short | ||
* use | * use lower case | ||
* don't use unexpected punctuation | * don't use unexpected punctuation | ||
* lack query parameters | * lack query parameters | ||
* allow public linking | * allow public linking | ||
* are stateless | * are stateless | ||
* | * don't expose technology | ||
(blatantly stolen from: http://www.eakes.org/archives/2005/01/flickr_uris.html ) | (blatantly stolen from: http://www.eakes.org/archives/2005/01/flickr_uris.html ) | ||
what not to do: | what not to do: | ||
* use | * use plural for parameter when you shouldn't (i.e. animes/5 instead of anime/5) | ||
* use "=1/=on". | * use "=1/=on". If the parameter is in the URL it ''is'' on. If not it's not, which leads to... | ||
* don't add | * don't add unnecessary parameters | ||
==Vision== | ==Vision== | ||
* 1(!) | * 1(!) standardized parser through which the data passes first | ||
* | * unnecessary scary things like /perl-bin/animedb.pl | ||
* structured URI | * structured URI | ||
* | * standardized parameter | ||
* let http://anidb.net/gonzo or http://anidb.net/chobits use the Full Text Search and return useful stuff instead of failing ([http://tracker.anidb.net/view.php?id=798|Tracker]]) | * let http://anidb.net/gonzo or http://anidb.net/chobits use the Full Text Search and return useful stuff instead of failing ([http://tracker.anidb.net/view.php?id=798|Tracker]]) | ||
* use dictionaries where possible and avoid | * use dictionaries where possible and avoid unnecessary & | ||
* use POST | * use POST instead of GET when possible. i.e. for adds, deletes, edits, votes. Basically anything that actually modifies data. For anything else (read only) gets should be used. | ||
* ... | * ... | ||
===shortterm simple Changes=== | ===shortterm simple Changes=== | ||
* get rid of "/perl-bin/animedb.pl" | * get rid of "/perl-bin/animedb.pl" | ||
yes we use | yes we use Perl. no we don't need to throw our "Perl penis into the face of everyone else" (as rar calls it) | ||
* ... | * ... | ||
| Line 45: | Line 46: | ||
actions could be: | actions could be: | ||
:* /show/ (could be used by default, but we should really just leave that out. | :* /show/ (could be used by default, but we should really just leave that out. unnecessary clutter. accepting it anyway would be fine though. accepting is fine. forcing is bad.) | ||
:* /edit/ | :* /edit/ | ||
:* /history/ | :* /history/ | ||
| Line 76: | Line 77: | ||
*http://www.alistapart.com/stories/urls/ | *http://www.alistapart.com/stories/urls/ | ||
*http://www.ibm.com/developerworks/library/us-cranky8.html?dwzone=usability | *http://www.ibm.com/developerworks/library/us-cranky8.html?dwzone=usability | ||
[[Category:Development]] | |||