php - Laravel RESTful API versioning design -


i new laravel (4 , 5) , working on restful api. in order allow multiple version of api, using url determine version.

i read follow post , seem people following approach: how organize different versioned rest api controllers in laravel 4?

folders structures:

/app   /controllers     /api       /v1         /usercontroller.php       /v2         /usercontroller.php

and in usercontroller.php files set namespace accordingly:

namespace api\v1;

or

namespace api\v2;

and in routes:

route::group(['prefix' => 'api/v1'], function () {   route::get('user',      'api\v1\usercontroller@index');   route::get('user/{id}', 'api\v1\usercontroller@show'); });  route::group(['prefix' => 'api/v2'], function () {   route::get('user',      'api\v2\usercontroller@index');   route::get('user/{id}', 'api\v2\usercontroller@show'); });

url simple http://..../api/v1 version 1 , http://..../api/v2 version. straight forward.

my questions is: if building minor upgrade of api, v1.1 , how organize folder structure? thought , should still fine dot valid name of folders? 

/app   /controllers     /api       /v1         /usercontroller.php       /v1.1         /usercontroller.php       /v1.2         /usercontroller.php       /v2         /usercontroller.php

also, how should write namespace? no namespace 

namespace api\v1.1;

is there naming convention can refer using "dot" ?

note: not want call version v2 because not major upgrade.

imo, minor upgrades should not publish breaking changes api. suggestion stick integer versioned apis. enhancements no problems, existing endpoints should behave usual.

this way api-versions in sync route-prefixes , namespaces tests.

example

  1. you begin v1.0
  2. you make little change (eg. git-tag v1.1) not bring breaking changes api. there need developers else in code? no, there not. can safeley let uri-prefix stay @ v1, developers calling api not need change code calling api (and therefore, automatically benefit new minor version). maybe fixed bug, makes code behave expected or published new feature, self not break existing feature-calls.
  3. your app grows , publish new redesigned version of api contains breaking changes. in case, publish new api-uri-prefix (v2).

be aware can of course keep track of minor versions internally (e.g in scm), there should no need developers change of api-calls benefit little bugfix published. anyways, nice of course if notify clients of newer minor versions , bugfixes or enhancements offer (blog, newsletter, ..)

let me add, not aware of restful apis minor api-url-prefixes, guess quite common practice.


Comments

Post a Comment

Popular posts from this blog

Email notification in google apps script -

https://support.google.com/docs/answer/91588?hl=en i have sheet the cells filled in data pulled via apps script, website. pull in exact same data, not. on old sheets version use able emails when data "changes" different value. new sheets, email when new data pasted cells, though exact same data......and, can't set @ ranges anymore, entire document. there easy way watch cells when data changes, , email myself? this looks lot you're trying do. for checking whether value has changed after edit, this gives necessary information it. hence, know whether new value same 1 or not. implementing "workaround" talked in second link, able compare , send email myself if value changed. initiate onedit trigger goes off onedit function uses these lines after checks in place have passed. var email = "xyz@whatever.com"; mailapp.sendemail(email, "triggermail", "a change has occurred in sheet"); note: sends "notification...
Read more

c++ - Difference between pre and post decrement in recursive function argument -

i have following sample code used pre-decrement void function(int c) { if(c == 0) { return; } else { cout << "dp" << c << endl; function(--c); cout << c << endl; return; } } this function give output input 4 : dp3 dp2 dp1 dp0 0 1 2 3 but when use post decrement void function(int c) { if(c == 0) { return; } else { cout << "dp" << c << endl; function(c--); cout << c << endl; return; } } output goes in infinite loop dp4 can explain me in detail why happens ? this happens because function(c--) called same value of c , when finishes c decremented. recursively called, hence called same value no chance of return , hit stack overflow error. assume this, int x = 1, y = 0; y = x++ result y == 1 , x == 2. if y = ++x , bot x , y 2.
Read more

javascript - IE11 incompatibility with jQuery's 'readonly'? -

the code i'm running has no issues in firefox, or chrome. user typing 1 textbox, tabs next , can continue typing that. when run webpage on ie11, user tabs next textbox , can't type in. textbox has double-clicked before user can insert anything. i've googled , seems ie give problems when using older jquery (i.e. prefers 'prop' 'attr' ). in code below jquery's readonly keyword being used in way ie11 no longer recognise/accept? i assume issue readonly , removeclass('ignore') working expected. //when focus on textbox 1 $("#field1").focus(function() { //remove readonly property textbox 1 $('#field1').prop('readonly', false).removeclass('ignore'); //add readonly property other textboxes $('#field2, #field3, #field4') .prop('readonly', 'readonly').addclass('ignore').val(''); }); i'm using jquery 2.1.3 ...
Read more