Opened 7 years ago

Last modified 7 years ago

#541 new enhancement

Use versioned API URLs

Reported by: spaetz Owned by: joar
Priority: trivial Milestone:
Component: programming Keywords:
Cc: Parent Tickets:

Description

The API development is phantastic, but it is bound to evolve and change heavily over time. To make things easier (ie more stable) for client developers, we should provide a versioned API. ie

use /api/1/entries/ /api/1/submit for now. This way we can deprecate existing API and replace it with newer one without constantly breaking clients.

Perhaps a /api/version call could return a list of supported API versions.

I think this should be done before MG becomes too widespread as breaking compatability is going to become harder then.

Does this sound sensible? I could help working on that if needed.

Subtickets

Change History (3)

comment:1 Changed 7 years ago by joar

I think this is a good idea.

Alas, as it looks at the moment I won't have any time to implement this.

Last edited 7 years ago by joar (previous) (diff)

comment:2 Changed 7 years ago by Christopher Allan Webber

Nathan Yergler has cautioned about this: at CC we versioned "too early" on the API and were left supporting a bunch of APIs, none of which were that great, and it was a huge maintainance burden.

comment:3 Changed 7 years ago by Christopher Allan Webber

Priority: majortrivial

It sounds like this is a good idea in the long run, but one that we shouldn't support anytime soon.

At the moment, I'm dropping the priority to trivial, not because it's trivial, but because it isn't time to work on this yet.

Note: See TracTickets for help on using tickets.