Choose URLs

[psimonyi]

In #102, we started discussing what form the /do URLs should have.

[spratt]

I don't really like the /do part. It is really just something short I used to proxy to the back-end.

I would like the following URLs to respond to GET requests:

• /code/unique-universial-identifier
• /comment/count/unique-universial-identifier
• /comments/unique-universal-identifier/8

And the following URLs to respond to POST requests

• /new/code
• /new/comment

And the following URLs to respond to OPTIONS requests

• /new/code

[spratt]

Maybe replace /do with /object ?

So the full url would be:

http://review.steamedpears.com/object/new/code

or

http://review.steamedpears.com/object/code/unique-universal-identifier

[cdelahousse]

From our discussion before the shit fest that was last Thriday:

We agreed /api/ is better than /object/

For getting content:
/api/code/ or /api/code/uuid with a get request.

For adding content:

• Simon likes /api/new/code with a post request.
  • Pro: explicit
  • con: lack of symmetry with the get resource.
• Bhee and Christian like /api/code with a put or post request
  • Basically, you're getting and setting to the same resource using differnt HTTP verbs
  • Pros: 1) to the best of my knowledge, it's more restful and adheres to those norms. (TODO: look that up). 2) more symmetric
  • Con: less explicit

[spratt]

Just to clarify, I suggest we get from /api/code/universal-unique-identifier and we push to /api/new/code.

[psimonyi]

+1 for /api. I like the idea of /api/code/new better than /api/new/code (cf. /api/code/<id>).

[spratt]

Alright. I like that it's explicit. I prefer <verb> <noun> like in English, but I can agree to this.

[spratt]

Also, I think of new as a verb.

[psimonyi]

<verb> <noun> works, but URIs are hierarchical: the more general thing comes first. (/api/newcode would be okay.)

[psimonyi]

On Wed, 2013-04-03 at 14:37 -0700, Simon David Pratt wrote:

Also, I think of new as a verb.
Call it the "action".

[spratt]

I like /api/code/new better than /api/newcode because the former sounds more like a resource.

[psimonyi]

I like it better because it's as if "new" is the ID; it's just a magical ID that redirects the POST to a new ID.