Re: URI construction for REST API and use of verbs as resource?
"Vinod Kumar Gupta [email protected] [rest-discuss]" <[email protected]> Wed, 17 Jun 2015 18:39:49 +0800
| Newsgroups | gmane.comp.web.services.rest |
|---|---|
| Message-ID | <CAJ6YGgWVbGhL_bzQpsEFSovtcQdF7hK=G2f9Shkp6itWyo3VTA@mail.gmail.com> |
--089e0111c0166ff18b0518b44fbb Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="UTF-8" Dear kalguni 1. The rest principle suggest you to follow the first approac= h. Since your resource hierarchy in such away it creates long url but it i= s the right way 2. Using verbs is not a good choice, always prefer nouns o= nly. It's my way of working based on the learning I had so far Regards Vi= nod On 17-Jun-2015 9:36 am, "[email protected] [rest-discuss]" < rest-disc= [email protected]> wrote: > > > Dear all, > > I have two questio= ns. > > 1) I have a issue of understanding the correct URL construction for= a REST > API. For example, > > https://api.context.io/lite/users/id/email_= accounts/label/folders/folder/messages/message_id > > Here as you can see t= he folder comes under folders resource and message_id > comes under message= s. Is it necessary to show the parent resource or > collection. Will it be = wrong to have a URL such as this? > > https://api.context.io/lite/userid/fo= lderid/message_id > > Here, the userid, folderid and message_id maybe would= indicate as integers > or some other value. Of course with the values the = URL doesn't make sense, > but does it matter in m2m transaction? What is th= e best way to construct > the URL? > > 2) Is it ok to have 'verbs' in the U= RL? I have seen the following urls > which has verbs such as 'move', 'send'= in the URL. Is that correct? If it > is wrong, should we do everything suc= h as 'search' using parameters only? > > POST https://outlook.office365.com= /api/v1.0/me/messages/{message_id}/move > POST https://www.googleapis.com/g= mail/v1/users/userId/messages/send > > Please share your thoughts. I read l= ots of articles on these. Yet it seems > to be more of a personal choice ra= ther than an Industry standard. > > Thanks in advance. > > > > --089e0111c0166ff18b0518b44fbb Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/htm= l4/strict.dtd"> <html> <head> </head> =20 <body style=3D"background-color: #fff;"> <span style=3D"display:none"> </span> <!--~-|**|PrettyHtmlStartT|**|-~--> <div id=3D"ygrp-mlmsg" style=3D"position:relative;"> <div id=3D"ygrp-msg" style=3D"z-index: 1;"> <!--~-|**|PrettyHtmlEndT|**|-~--> <div id=3D"ygrp-text" > =20=20=20=20=20=20 =20=20=20=20=20=20 <p><p dir=3D"ltr">Dear kalguni </p> <p dir=3D"ltr">1. The rest principle suggest you to follow the first approa= ch.=C2=A0 Since your resource hierarchy in such away it creates long url bu= t it is the right way <br> 2. Using verbs is not a good choice,=C2=A0 always prefer nouns only. </p> <p dir=3D"ltr">It's my way of working based on the learning I had so fa= r </p> <p dir=3D"ltr">Regards <br> Vinod <br> </p> <div class=3D"gmail_quote">On 17-Jun-2015 9:36 am, "<a href=3D"mailto:= [email protected]">[email protected]</a> [rest-discuss]" <<a href= =3D"mailto:[email protected]">rest-discuss-noreply@yahoo= groups.com</a>> wrote:<br type=3D"attribution"><blockquote class=3D"gmai= l_quote" style=3D"border-left:1px #ccc solid;"> <u></u> =20 <div style=3D"background-color:#fff;"> <span>=C2=A0</span> <div> <div> <div> =20=20=20=20=20=20 =20=20=20=20=20=20 <p><p style=3D"margin:0px 0px 1em;padding:0px;font-size:14px;vertical= -align:baseline;color:rgb(51,51,51);font-family:Tahoma,Geneva,Arial,sans-se= rif;font-style:normal;font-variant:normal;font-weight:normal;letter-spacing= :normal;">Dear all,</p><p style=3D"margin:0px 0px 1em;padding:0px;font-size= :14px;vertical-align:baseline;color:rgb(51,51,51);font-family:Tahoma,Geneva= ,Arial,sans-serif;font-style:normal;font-variant:normal;font-weight:normal;= letter-spacing:normal;">I have two questions.</p><p style=3D"margin:0px 0px= 1em;padding:0px;font-size:14px;vertical-align:baseline;color:rgb(51,51,51)= ;font-family:Tahoma,Geneva,Arial,sans-serif;font-style:normal;font-variant:= normal;font-weight:normal;letter-spacing:normal;">1) I have a issue of unde= rstanding the correct URL construction for a REST API. For example,</p><pre= style=3D"margin:0px 0px 10px;padding:5px;font-size:12px;vertical-align:bas= eline;overflow:auto;width:auto;max-height:600px;font-family:Consolas,Menlo,= Monaco,'Lucida Console','Liberation Mono','DejaVu Sans Mono','Bitstream Ver= a Sans Mono','Courier New',monospace,serif;color:rgb(51,51,51);font-style:n= ormal;"><code style=3D"margin:0px;padding:0px;font-size:12px;vertical-align= :baseline;font-family:Consolas,Menlo,Monaco,'Lucida Console','Liberation Mo= no','DejaVu Sans Mono','Bitstream Vera Sans Mono','Courier New',monospace,s= erif;color:rgb(34,34,34);white-space:inherit;background-color:rgb(238,238,2= 38);"><a href=3D"https://api.context.io/lite/users/id/email_accounts/label/= folders/folder/messages/message_id" target=3D"_blank">https://api.context.i= o/lite/users/id/email_accounts/label/folders/folder/messages/message_id</a> </code></pre><p style=3D"margin:0px 0px 1em;padding:0px;font-size:14px;vert= ical-align:baseline;color:rgb(51,51,51);font-family:Tahoma,Geneva,Arial,san= s-serif;font-style:normal;font-variant:normal;font-weight:normal;letter-spa= cing:normal;">Here as you can see the folder comes under folders resource a= nd message_id comes under messages. Is it necessary to show the parent reso= urce or collection. Will it be wrong to have a URL such as this?</p><pre st= yle=3D"margin:0px 0px 10px;padding:5px;font-size:12px;vertical-align:baseli= ne;overflow:auto;width:auto;max-height:600px;font-family:Consolas,Menlo,Mon= aco,'Lucida Console','Liberation Mono','DejaVu Sans Mono','Bitstream Vera S= ans Mono','Courier New',monospace,serif;color:rgb(51,51,51);font-style:norm= al;"><code style=3D"margin:0px;padding:0px;font-size:12px;vertical-align:ba= seline;font-family:Consolas,Menlo,Monaco,'Lucida Console','Liberation Mono'= ,'DejaVu Sans Mono','Bitstream Vera Sans Mono','Courier New',monospace,seri= f;color:rgb(34,34,34);white-space:inherit;background-color:rgb(238,238,238)= ;"><a href=3D"https://api.context.io/lite/userid/folderid/message_id" targe= t=3D"_blank">https://api.context.io/lite/userid/folderid/message_id</a> </code></pre><p style=3D"margin:0px 0px 1em;padding:0px;font-size:14px;vert= ical-align:baseline;color:rgb(51,51,51);font-family:Tahoma,Geneva,Arial,san= s-serif;font-style:normal;font-variant:normal;font-weight:normal;letter-spa= cing:normal;">Here, the userid, folderid and message_id maybe would indicat= e as integers or some other value. Of course with the values the URL doesn&= #39;t make sense, but does it matter in m2m transaction? What is the best w= ay to construct the URL?</p><p style=3D"margin:0px 0px 1em;padding:0px;font= -size:14px;vertical-align:baseline;color:rgb(51,51,51);font-family:Tahoma,G= eneva,Arial,sans-serif;font-style:normal;font-variant:normal;font-weight:no= rmal;letter-spacing:normal;">2) Is it ok to have 'verbs' in the URL= ? I have seen the following urls which has verbs such as 'move', &#= 39;send' in the URL. Is that correct? If it is wrong, should we do ever= ything such as 'search' using parameters only?</p><pre style=3D"mar= gin:0px 0px 10px;padding:5px;font-size:12px;vertical-align:baseline;overflo= w:auto;width:auto;max-height:600px;font-family:Consolas,Menlo,Monaco,'Lucid= a Console','Liberation Mono','DejaVu Sans Mono','Bitstream Vera Sans Mono',= 'Courier New',monospace,serif;color:rgb(51,51,51);font-style:normal;"><code= style=3D"margin:0px;padding:0px;font-size:12px;vertical-align:baseline;fon= t-family:Consolas,Menlo,Monaco,'Lucida Console','Liberation Mono','DejaVu S= ans Mono','Bitstream Vera Sans Mono','Courier New',monospace,serif;color:rg= b(34,34,34);white-space:inherit;background-color:rgb(238,238,238);">POST <a= href=3D"https://outlook.office365.com/api/v1.0/me/messages/%7Bmessage_id%7= D/move" target=3D"_blank">https://outlook.office365.com/api/v1.0/me/message= s/{message_id}/move</a> POST <a href=3D"https://www.googleapis.com/gmail/v1/users/userId/messages/s= end" target=3D"_blank">https://www.googleapis.com/gmail/v1/users/userId/mes= sages/send</a> </code></pre><p style=3D"margin:0px 0px 1em;padding:0px;font-size:14px;vert= ical-align:baseline;color:rgb(51,51,51);font-family:Tahoma,Geneva,Arial,san= s-serif;font-style:normal;font-variant:normal;font-weight:normal;letter-spa= cing:normal;">Please share your thoughts. I read lots of articles on these.= Yet it seems to be more of a personal choice rather than an Industry stand= ard. <br></p><p style=3D"margin:0px 0px 1em;padding:0px;font-size:14px;vert= ical-align:baseline;color:rgb(51,51,51);font-family:Tahoma,Geneva,Arial,san= s-serif;font-style:normal;font-variant:normal;font-weight:normal;letter-spa= cing:normal;">Thanks in advance.</p><p><span><br></span></p></p> </div> =20=20=20=20=20 =20=20=20=20 <div style=3D"color:#fff;min-height:0;"></div> </div> =20=20 </div></div></blockquote></div> </p> </div> =20=20=20=20=20 <!--~-|**|PrettyHtmlStart|**|-~--> <div style=3D"color: #fff; height: 0;">__._,_.___</div> =20=20=20=20=20=20=20=20=20=20 =20=20 =20 =20=20=20=20 <div style=3D"clear:both"> </div> <div id=3D"fromDMARC" style=3D"margin-top: 10px;"> <hr style=3D"height:2px ; border-width:0; color:#E3E3E3; background= -color:#E3E3E3;"> Posted by: Vinod Kumar Gupta <[email protected]> <hr s= tyle=3D"height:2px ; border-width:0; color:#E3E3E3; background-color:#E3E3E= 3;"> </div> <div style=3D"clear:both"> </div> <table cellspacing=3D4px style=3D"margin-top: 10px; margin-bottom: 10px= ; color: #2D50FD;"> <tbody> <tr> <td style=3D"font-size: 12px; font-family: arial; font-weight: bo= ld; padding: 7px 5px 5px;" > <a style=3D"text-decoration: none; color: #2D50FD= " href=3D"https://groups.yahoo.com/neo/groups/rest-discuss/conversations/me= ssages/19720;_ylc=3DX3oDMTJxODQ1bjg1BF9TAzk3MzU5NzE0BGdycElkAzQzMTkyNTUEZ3J= wc3BJZAMxNzA1NzAxMDE0BG1zZ0lkAzE5NzIwBHNlYwNmdHIEc2xrA3JwbHkEc3RpbWUDMTQzND= U0ODIwMg--?act=3Dreply&messageNum=3D19720">Reply via web post</a> </td> <td>•</td> <td style=3D"font-size: 12px; font-family: arial; padding: 7px 5p= x 5px;" > <a href=3D"mailto:[email protected]?subject=3DRe%3A%20%5Brest-d= iscuss%5D%20URI%20construction%20for%20REST%20API%20and%20use%20of%20verbs%= 20as%20resource%3F" style=3D"text-decoration: none; color: #2D50FD;"> Reply to sender </a> </td> <td>•</td> <td style=3D"font-size: 12px; font-family: arial; padding: 7px 5p= x 5px;"> <a href=3D"mailto:[email protected]?subject=3DRe%3A%= 20%5Brest-discuss%5D%20URI%20construction%20for%20REST%20API%20and%20use%20= of%20verbs%20as%20resource%3F" style=3D"text-decoration: none; color: #2D50= FD"> Reply to group </a> </td> <td>•</td> <td style=3D"font-size: 12px; font-family: arial; padding: 7px 5p= x 5px;" > <a href=3D"https://groups.yahoo.com/neo/groups/rest-discuss/con= versations/newtopic;_ylc=3DX3oDMTJlam5mNmRkBF9TAzk3MzU5NzE0BGdycElkAzQzMTky= NTUEZ3Jwc3BJZAMxNzA1NzAxMDE0BHNlYwNmdHIEc2xrA250cGMEc3RpbWUDMTQzNDU0ODIwMg-= -" style=3D"text-decoration: none; color: #2D50FD">Start a New Topic</a> </td> <td>•</td> <td style=3D"font-size: 12px; font-family: arial; padding: 7px 5p= x 5px;color: #2D50FD;" > <a href=3D"https://groups.yahoo.com/neo/groups/= rest-discuss/conversations/topics/19716;_ylc=3DX3oDMTM2bnVwaGlnBF9TAzk3MzU5= NzE0BGdycElkAzQzMTkyNTUEZ3Jwc3BJZAMxNzA1NzAxMDE0BG1zZ0lkAzE5NzIwBHNlYwNmdHI= Ec2xrA3Z0cGMEc3RpbWUDMTQzNDU0ODIwMgR0cGNJZAMxOTcxNg--" style=3D"text-decora= tion: none; color: #2D50FD;">Messages in this topic</a> (5) </td> </tr> </tbody> </table> =20=20=20=20=20=20=20=20 <!------- Start Nav Bar ------> =20 <!-- |**|begin egp html banner|**| --> <div id=3D"ygrp-vital" style=3D"background-color: #f2f2f2; font-family: Ver= dana; font-size: 10px; margin-bottom: 10px; padding: 10px;"> <span id=3D"vithd" style=3D"font-weight: bold; color: #333; text-transf= orm: uppercase; "><a href=3D"https://groups.yahoo.com/neo/groups/rest-discu= ss/info;_ylc=3DX3oDMTJlOHMxbXRkBF9TAzk3MzU5NzE0BGdycElkAzQzMTkyNTUEZ3Jwc3BJ= ZAMxNzA1NzAxMDE0BHNlYwN2dGwEc2xrA3ZnaHAEc3RpbWUDMTQzNDU0ODIwMg--" style=3D"= text-decoration: none;">Visit Your Group</a></span> <ul style=3D"list-style-type: none; margin: 0; padding: 0; display: in= line;"> <li style=3D"border-right: 1px solid #000; font-weight: 700; di= splay: inline; padding: 0 5px; margin-left: 0;"> <span class=3D"cat"><a href=3D"https://groups.yahoo.com/neo/groups/re= st-discuss/members/all;_ylc=3DX3oDMTJmbHM4cHRlBF9TAzk3MzU5NzE0BGdycElkAzQzM= TkyNTUEZ3Jwc3BJZAMxNzA1NzAxMDE0BHNlYwN2dGwEc2xrA3ZtYnJzBHN0aW1lAzE0MzQ1NDgy= MDI-" style=3D"text-decoration: none;">New Members</a></span> <span class=3D"ct" style=3D"color: #ff7900;">1</span> </li> </ul> </div> <div id=3D"ft" style=3D"font-family: Arial; font-size: 11px; margin-top: 5p= x; padding: 0 2px 0 0; clear: both;"> <a href=3D"https://groups.yahoo.com/neo;_ylc=3DX3oDMTJkNzc5cGF0BF9TAzk3ND= c2NTkwBGdycElkAzQzMTkyNTUEZ3Jwc3BJZAMxNzA1NzAxMDE0BHNlYwNmdHIEc2xrA2dmcARzd= GltZQMxNDM0NTQ4MjAy" style=3D"float: left;"><img src=3D"http://l.yimg.com/r= u/static/images/yg/img/email/new_logo/logo-groups-137x15.png" height=3D"15"= width=3D"137" alt=3D"Yahoo! Groups" style=3D"border: 0;"/></a> <div style=3D"color: #747575; float: right;"> • <a href=3D"https://i= nfo.yahoo.com/privacy/us/yahoo/groups/details.html" style=3D"text-decoratio= n: none;">Privacy</a> • <a href=3D"mailto:rest-discuss-unsubscribe@yah= oogroups.com?subject=3DUnsubscribe" style=3D"text-decoration: none;">Unsubs= cribe</a> • <a href=3D"https://info.yahoo.com/legal/us/yahoo/utos/term= s/" style=3D"text-decoration: none;">Terms of Use</a> </div> </div> <br> <!-- |**|end egp html banner|**| --> </div> <!-- ygrp-msg --> =20 <!-- Sponsor --> <!-- |**|begin egp html banner|**| --> <div id=3D"ygrp-sponsor" style=3D"width:160px; float:right; clear:none; m= argin:0 0 25px 0; background: #fff;"> <!-- Start Recommendations --> <div id=3D"ygrp-reco"> </div> <!-- End Recommendations --> </div> <!-- |**|end egp html banner|**| --> <div style=3D"clear:both; color: #FFF; font-size:1px;">.</div> </div> <img src=3D"http://geo.yahoo.com/serv?s=3D97359714/grpId=3D4319255/grpspI= d=3D1705701014/msgId=3D19720/stime=3D1434548202" width=3D"1" height=3D"1"> = <br> <img src=3D"http://y.analytics.yahoo.com/fpc.pl?ywarid=3D515FB27823A7407E&a= =3D10001310322279&js=3Dno&resp=3Dimg" width=3D"1" height=3D"1">=20 <div style=3D"color: #fff; height: 0;">__,_._,___</div> <!--~-|**|PrettyHtmlEnd|**|-~--> </body> <!--~-|**|PrettyHtmlStart|**|-~--> <head> <style type=3D"text/css"> <!-- #ygrp-mkp { border: 1px solid #d8d8d8; font-family: Arial; margin: 10px 0; padding: 0 10px; } #ygrp-mkp hr { border: 1px solid #d8d8d8; } #ygrp-mkp #hd { color: #628c2a; font-size: 85%; font-weight: 700; line-height: 122%; margin: 10px 0; } #ygrp-mkp #ads { margin-bottom: 10px; } #ygrp-mkp .ad { padding: 0 0; } #ygrp-mkp .ad p { margin: 0; } #ygrp-mkp .ad a { color: #0000ff; text-decoration: none; } #ygrp-sponsor #ygrp-lc { font-family: Arial; } #ygrp-sponsor #ygrp-lc #hd { margin: 10px 0px; font-weight: 700; font-size: 78%; line-height: 122%; } #ygrp-sponsor #ygrp-lc .ad { margin-bottom: 10px; padding: 0 0; } #actions { font-family: Verdana; font-size: 11px; padding: 10px 0; } #activity { background-color: #e0ecee; float: left; font-family: Verdana; font-size: 10px; padding: 10px; } #activity span { font-weight: 700; } #activity span:first-child { text-transform: uppercase; } #activity span a { color: #5085b6; text-decoration: none; } #activity span span { color: #ff7900; } #activity span .underline { text-decoration: underline; } .attach { clear: both; display: table; font-family: Arial; font-size: 12px; padding: 10px 0; width: 400px; } .attach div a { text-decoration: none; } .attach img { border: none; padding-right: 5px; } .attach label { display: block; margin-bottom: 5px; } .attach label a { text-decoration: none; } =20=20 blockquote { margin: 0 0 0 4px; } .bold { font-family: Arial; font-size: 13px; font-weight: 700; } .bold a { text-decoration: none; } dd.last p a { font-family: Verdana; font-weight: 700; } dd.last p span { margin-right: 10px; font-family: Verdana; font-weight: 700; } dd.last p span.yshortcuts { margin-right: 0; } div.attach-table div div a { text-decoration: none; } div.attach-table { width: 400px; } div.file-title a, div.file-title a:active, div.file-title a:hover, div.fi= le-title a:visited { text-decoration: none; } div.photo-title a, div.photo-title a:active, div.photo-title a:hover, div= .photo-title a:visited { text-decoration: none; } div#ygrp-mlmsg #ygrp-msg p a span.yshortcuts { font-family: Verdana; font-size: 10px; font-weight: normal; } .green { color: #628c2a; } .MsoNormal { margin: 0 0 0 0; } o { font-size: 0; } #photos div { float: left; width: 72px; } #photos div div { border: 1px solid #666666; height: 62px; overflow: hidden; width: 62px; } #photos div label { color: #666666; font-size: 10px; overflow: hidden; text-align: center; white-space: nowrap; width: 64px; } #reco-category { font-size: 77%; } #reco-desc { font-size: 77%; } .replbq { margin: 4px; } #ygrp-actbar div a:first-child { /* border-right: 0px solid #000;*/ margin-right: 2px; padding-right: 5px; } #ygrp-mlmsg { font-size: 13px; font-family: Arial, helvetica,clean, sans-serif; *font-size: small; *font: x-small; } #ygrp-mlmsg table { font-size: inherit; font: 100%; } #ygrp-mlmsg select, input, textarea { font: 99% Arial, Helvetica, clean, sans-serif; } #ygrp-mlmsg pre, code { font:115% monospace; *font-size:100%; } #ygrp-mlmsg * { line-height: 1.22em; } #ygrp-mlmsg #logo { padding-bottom: 10px; } #ygrp-msg p a { font-family: Verdana; } #ygrp-msg p#attach-count span { color: #1E66AE; font-weight: 700; } #ygrp-reco #reco-head { color: #ff7900; font-weight: 700; } #ygrp-reco { margin-bottom: 20px; padding: 0px; } #ygrp-sponsor #ov li a { font-size: 130%; text-decoration: none; } #ygrp-sponsor #ov li { font-size: 77%; list-style-type: square; padding: 6px 0; }=20 #ygrp-sponsor #ov ul { margin: 0; padding: 0 0 0 8px; } #ygrp-text { font-family: Georgia; } #ygrp-text p { margin: 0 0 1em 0; } #ygrp-text tt { font-size: 120%; } #ygrp-vital ul li:last-child { border-right: none !important;=20 }=20 --> </style> </head> <!--~-|**|PrettyHtmlEnd|**|-~--> </html> <!-- end group email --> --089e0111c0166ff18b0518b44fbb--