json - REST service semantics; include properties not being updated? -

-

suppose have resource called person. can update person entities doing post /data/person/{id}. suppose simplicity person has 3 properties, first name, last name, , age.

get /data/person/1 yields like:

{ id: 1, firstname: "john", lastname: "smith", age: 30 }.

my question updates person , semantics of services this. suppose wanted update john, he's 31. in terms of design approach, i've seen apis work 2 ways:

option 1:

post /data/person/1 { id: 1, age: 31 } right thing. implicitly, property isn't mentioned isn't updated.

option 2:

post /data/person/1 full object have been received get -- properties must specified, if many don't change, because api (in presence of missing property) assume proper value null.

which option correct recommended design perspective? option 1 attractive because it's short , simple, has downside of being ambiguous in cases. option 2 has sending lot of data , forth if it's not changing, , doesn't tell server what's important payload (only age changed).

option 1 - updating subset of resource - formalised in http patch method. option 2 - updating whole resource - put method.

in real-world scenarios, it's common want upload subset of resource. better performance of request , modularity/diversity of clients.

for reason, patch more useful put in typical api (imo), though can support both if want to. there few corner cases platform may not support patch, believe rare now.

if support both, don't make them interchangeable. difference put is, if receives subset, should assume whole thing uploaded, should apply default properties omitted, or return error if required. whereas patch ignore omitted properties.


Comments

Post a Comment

Popular posts from this blog

yii2 - Yii 2 Running a Cron in the basic template -

-
i have seen instructions on running cron in advanced template, cant figure out how on basic template. have following controller in basic controllers folder. <?php namespace app\controllers; use yii\console\controller; /** * cron controller */ class croncontroller extends controller { public function actionindex() { echo "cron service runnning"; } public function actionmail($to) { echo "sending mail " . $to; } } i have navigated root of application , tried these comands yii cron php yii cron im getting unknown comand "cron" i know old question failed find actual answer this. if @ code yii exec file you'll notice requires /common/config/aliases.php file console/config/main.php. can naturally change these or copy on these advanced template. hope solves problem wanting same thing.
Read more

asp.net - 'System.Web.HttpContext' does not contain a definition for 'GetOwinContext' Mystery -

-
i realize question might seem trivial some, it's these types of things find myself fighting quite bit , want make sense of despite seeming losing battle in .net (for me anyway). so, if following: using system.web; ... applicationuser user = system.web.httpcontext.getowincontext().getusermanager<applicationusermanager>().findbyid(system.web.httpcontext.user.identity.getuserid()); that produces error in title , red getowincontext() , error cannot resolve symbol 'getowincontext()' however, if following (remove system.web in front of httpcontext ), works expected (or @ least no errors): using system.web; ... applicationuser user = httpcontext.getowincontext().getusermanager<applicationusermanager>().findbyid(system.web.httpcontext.user.identity.getuserid()); however, if (same line that's working using system.web commented out): //using system.web; ... applicationuser user = httpcontext.getowincontext().getusermana...
Read more

mercurial graft feature, can it copy? -

-
there new feature in mercurial 3, called 'graft' (graft local). job of moving change-set different branch. is there way "copy" change-set branch? i interested in in moving stuff qa branch production branch, still need code reside in qa. want copy. found , have tried few things, maybe it'll become clear more tinkering , reading... does have better way of 'cherry picking' change-sets move cross branch (or trunk)??? graft copies changesets, doesn't move them. hg graft (emphasis mine): this command uses mercurial's merge logic copy individual changes other branches without merging branches in history graph. known 'backporting' or 'cherry-picking' . default, graft copy user, date, , description source changesets.
Read more