DC311 API Version number

[El Greg]

A common best practice for RESTful APIS is to include the version
number of the API in the various URLs that are called (i.e.
http://api.dc.gov/api_name/version/method.format?etc)

Just thought I'd mention it since this API is so new and applications
built this weekend will be relying on such an early version of it.

[Dmitry Kachaev]

Great,
will try to incorporate it ASAP.

Are you ok with JSON format or do you need XML as well?

What about items 4 and 5 from http://www.prescod.net/rest/mistakes/ ?

-Dmitry

On Jun 2, 1:56 pm, El Greg <greglaval...@gmail.com> wrote:
> A common best practice for RESTful APIS is to include the version

> number of the API in the various URLs that are called (i.e.http://api.dc.gov/api_name/version/method.format?etc)

[Greg Lavallee]

JSON is preferred for me and I'm guessing others.

Number 4 is definitely a no-no as google might accidentally request it, especially bad with DELETEs, though I doubt that you're offering them.

Some notes I took from a RESTful APIs session I attended once remind me of this:

• Use last modified headers
• A good URI is guessable
• Offer Atom when it makes sense
• Offer iCal when it makes sense
• Provide a client example for your API
• Use OAuth (easie said than done, I'm sure)

[Dmitry Kachaev]

Done! "/v1" added as version number. Docs and API are updated.

On Jun 2, 1:56 pm, El Greg <greglaval...@gmail.com> wrote:

> A common best practice for RESTful APIS is to include the version

> number of the API in the various URLs that are called (i.e.http://api.dc.gov/api_name/version/method.format?etc)