Versioning a PHP Lithium API -


goal

i've been tasked versioning pretty large php lithium api.

the end result i'm looking use namespacing separate versions.

for example, lithium route looked this:

router::connect('/{:controller}/{:action}/{:id:\d+}');

could have following url, map following php call:

http://www.fungames.com/game/view/2 app\controllers\game::view($gameid)

but create following mapping:

router::connect('/{:version}/{:controller}/{:action}/{:id:\d+}');

such following 2 calls made:

http://www.fungames.com/v1/game/view/2 app\controllers\v1\game::view($gameid)  http://www.fungames.com/v2/game/view/2 app\controllers\v2\game::view($gameid)

problem

unfortunately, lithium documentation doesn't make mention of api versioning. there's brief mention here example of continuation routes. approach required making if statements in controllers version api, , consider poor approach.

tldr

what best way achieved namespaced api versioning when using php lithium framework?

api versioning broad topic, , while li3 gives necessary tools implement approach choose, actual implementation you. having said that, routing layer sophisticated , very, far. see this gist on routing configuration examples.

combining request::get() allows match on request parameters including headers (you can pass get()-compatible values $params in router::connect() — see examples here), , request::detect(), allows implement custom matching logic, can send configuration of values down controller/dispatch layer. allows segment versions differently namespaced controllers (with fallback default), prefixed actions, or pass namespace/class path different model.

yet approach, , 1 recommend in general case, implementing set of transaction managers/mappers endpoints need versioned, , using them intermediary between controller , model, use routing switch between them.

this approach made easier if evolve api using, i.e. content types, since can choose mapper based on that. nice since version numbers discouraged rest's creator.

anyway, hope helps.


Comments

Post a Comment

Popular posts from this blog

node.js - Node js - Trying to send POST request, but it is not loading javascript content -

i have been trying send post request website, , has not been loading full site. i guessing problem node js not loading javascript content, executing it. can see javascript in response, though never loads content javascript files producing in html. what mean is, doesn't execute javascript. how make node js code overcome this, , wait the full website load? have tried native code, , "request' module, both producing same errors. if helps, don't need native javascript. modules fine. some code have tried (request module): var options = { method: 'post', uri: 'https://url', formdata: { 'email': 'email', 'prize': '0', 'transactional': 'on' }, headers: { /* 'content-type': 'application/x-www-form-urlencoded' */ // set automatically } }; rp(options) .then(function (body) { console.log(body) }) .catch(function (err) { console.log(err) }); when fetch content...
Read more

javascript - Replicate keyboard event with html button -

i have tried few ways make happen. have javascript pinball game uses keyboard keys controls. converting application touch screen display. workaround, hoping overlay buttons when clicked simulate keyboard strokes. have done research , sounds should work. using jquery v3.2.1 here things have tried far... html element: <input type="button" class="coil"></input> $('.coil').trigger({type: 'keydown', which: 40, keycode: 40}); with this, not errors, nothing happens. var coilkey = $('body').keydown(function(e) { switch (e.keycode) { case 40: break;} }) $('.coil').click(coilkey); this 1 returns error in console... ((jquery.event.special[handleobj.origtype] || (intermediate value)).handle || handleobj.handler).apply not function below javascript game engine handles key listeners... addkeylistener: function (keyandlistener) { this.keylisteners.push(keyandlistener); }, // gi...
Read more

javascript - Web audio api 5.1 surround example not working in firefox -

i've been playing lott lately web audio api on both firefox , chrome. few days ago started experiment surround set. when trying surround audio in web audio api came notice example works fine in chrome v59 not in firefox v54. // create web audio api context var audioctx = new (window.audiocontext || window.webkitaudiocontext)(); audioctx.destination.channelinterpretation = 'discrete'; audioctx.destination.channelcountmode = 'explicit'; audioctx.destination.channelcount = 6; var oscillators = []; var merger = audioctx.createchannelmerger(6); console.log(audioctx.destination, merger); //merger.channelinterpretation = 'discrete'; //merger.channelcountmode = 'explicit'; //merger.channelcount = 6; var addoscilator = function(channel, frequency) { var oscillator = audioctx.createoscillator(); oscillator.frequency.value = frequency; // value in hertz oscillator.connect(merger,0,channel); oscillator.start(); oscillators.push(o...
Read more