Falcon: Best way to implement API Versioning
Hi,
Loving learning falcon - having the source so cleanly written has been a big help.
I'm looking to implement a versioned API with falcon - either in the endpoint ("/api/1.0/foo") or as a header - but trying to work out the best way to do it, short of having a route added for each instance of each route for each version.
I looked at subclassing the router to look for the API in the uristring and switching resource function based on that, but the router only gets access to the template; not the variable, so can't utilise it.
Then i looked at middleware, but it doesn't look like you can change the resource from middleware callbacks; am i right?
What would you suggest?
coffeedoughnuts
All 8 comments
API Versioning will be a awesome feature in Falcon.
berlotto
on 16 Jan 2016
+1
I'm trying to figure out how to implement versioning in a clean way and I don't find any solution...
Any ideas?
jf86
on 1 Mar 2016
I'd like to get a better idea of how everyone envisions their resource classes being implemented to elegantly support a versioned API, and then work back from that to see what additional affordances the framework might require to support that design.
Currently, you can do some things by implementing a middleware process_request() method that rewrites the path (based on a header or incoming path) in order to influence the route (and resource) that is chosen. We can also evolve the routing components to be more flexible.
Another thing to consider is how best to support versioned media types. This probably dovetails with #145.
kgriffs
on 4 Mar 2016
For a while, I did this:
import all classes and create the objetcs for the endpoints, and after, create the routes:
/v1/endpoint1
/v2/endpoint1.1
Simple, but not mutch fast.
berlotto
on 6 Mar 2016
According to various resources that I've read, the recommended way to use API versioning is through Accept Header
http://www.troyhunt.com/2014/02/your-api-versioning-is-wrong-which-is.html
http://stackoverflow.com/questions/972226/how-to-version-rest-uris
http://www.django-rest-framework.org/api-guide/versioning/
jf86
on 9 Mar 2016
Hi ,
Is there any progress on this issue?
I like Falcon but i can't find an easy way to achieve this.
TheMushrr00m
on 10 May 2018
+1
API versioning in falcon would definitely be great!
SyedMHashim
on 12 Nov 2020
@TheMushrr00m and @SyedMHashim ,
unfortunately there hasn't been much progress on this issue.
See also a more specific discussion (versioning by Accept) here: https://github.com/falconry/falcon/issues/932
As I wrote on that one, maybe we could start off with a recipe employing a custom router... It looks like the required framework building blocks were laid out here: https://github.com/falconry/falcon/pull/995
vytas7
on 13 Nov 2020
Related issues
w1z2g3
路
7Comments
codenoid
路
4Comments
xiaodi007
路
4Comments
bootrino
路
3Comments
benzid-wael
路
3Comments
Most helpful comment
I'd like to get a better idea of how everyone envisions their resource classes being implemented to elegantly support a versioned API, and then work back from that to see what additional affordances the framework might require to support that design.
Currently, you can do some things by implementing a middleware
process_request()method that rewrites the path (based on a header or incoming path) in order to influence the route (and resource) that is chosen. We can also evolve the routing components to be more flexible.Another thing to consider is how best to support versioned media types. This probably dovetails with #145.