REST design for API accessing multiple resources -


imagine api returns json data tv listings app zap2it tv listings.

it's list of tv channels , each channel shows on , beyond. currently, have api returns channels get /channels. however, there need add show on each channel in data. thinking of adding new api, get /channels/on_now, differentiate current api. i want clear new api, don't want make individual call each channel, show-on-now data needs returned channels. rest api design?

current get /channels json data

[    "channel": {       "channelname": "kron4",     },    "channel": {       "channelname": "ktov5",     },    ... ]

expected json data new api get /channels/on_now below

[   {    "channel": {       "channelname": "kron4",     },     "on_now": {       "starttime": "2012-06-04t11:30:00",       "endtime": "2012-06-04t12:00:00",       "shortdescription": "latest local, statewide & national news events, along sports & weather.",       "shorttitle": "4:30am newscast"     }   },   {    "channel": {       "channelname": "ktov5",     },     "on_now": {       "starttime": "2012-06-04t11:30:00",       "endtime": "2012-06-04t12:30:00",       "shortdescription": "local morning news , weather report",       "shorttitle": "morning newscast"     }   },   ...next channel... ]

i advice concentrate on content, not on urls.

example: you've got entry point, '/'. url in api. on return st like

{     "channels" : {         "href" : "path.to/channels"         },     "programs" : {         "href" : "path.to/programs"         } }

to retrieve list of channels, on corresponding url - don't need know before - , obtain, example:

[     {         "name" : "bbc",         "id" : 452,         "href" : "path.to/channels/452"     },     {         "name" : "foo",         "id"   : 112,         "href" : "path.to/channels/112"     } ]

for detailled information bbc, on provided url:

{     "name" : "bbc",     "id" : 452,     "self" : "path.to/channels/452",     "live_url" : "link.to.bbc.cast",     "whatever" : "bar",     "current" : "path.to/channels/452/current",     "program" : "path.to/channels/452/program" }

and on. urls discovered on fly; free modify them anytime. makes api content: have agree clients returned (fields, types, ...). call "current" url above obtain information current program.

read here more: http://kellabyte.com/2011/09/04/clarifying-rest/

edit after op-comment:

you introduce 'embed' parameter limit amount of requests:

get path.to/channels/452?embed=current

would return:

{     "name" : "bbc",     "id" : 452,     "self" : "path.to/channels/452",     "live_url" : "link.to.bbc.cast",     "whatever" : "bar",     "current" : {         "self" : "path.to/channels/452/current",         "name" : "morning show",         "start_time" : "(datetime here)",         "end_time"   : "(datetime here)",         "next"       : "whatever.comes.ne/xt"         },     "program" : "path.to/channels/452/program" }

Comments

Post a Comment

Popular posts from this blog

java - Play! framework 2.0: How to display multiple image? -

i need display gallery of photos. here template: @(photos: list[photo]) @title = { <bold>gallery</bold> } @main(title,"photo"){ <ul class="thumbnails"> @for(photo <- photos) { <li class="span3"> <a href="#" class="thumbnail"> <img src="@photo.path" alt=""> </a> </li> } </ul> } and here controller method: public static result getphotos() { return ok(views.html.photo.gallery.render(photo.get())); } and here photo bean : @entity public class photo extends model { @id public long id; @required public string label; public string path; public photo(string path, string label) { this.path = path; this.label = label; } private static finder<long, photo> find = new finder<long, photo>( long.class, photo.class); public static list<phot...
Read more

gmail - Is there any documentation for read-only access to the Google Contacts API? -

i want read-only access user's google contacts. there stackoverflow member wanted this, , received following answer : yes, there is, use https://www.googleapis.com/auth/contacts.readonly scope , "view contacts". this exchange reference read-only access google contacts can find using google. simply using access token obtained attempt read usual google contacts api (i.e. https://www.google.com/m8/feeds ) fails insufficient permissions. similarly, using google contacts api on new target fails 404 errors (for example https://www.googleapis.com/auth/contacts.readonly/default/full ). is there documentation anywhere on how use api, or permissible way access google contacts api full read-write access?
Read more

php - Controller/JToolBar not working in Joomla 2.5 -

relevant code: jtoolbarhelper::custom('savecategories', 'save', '', 'save', false, false); ... <input type="hidden" name="controller" value="easyblogcontroller"> according can dig docs , own previous questions, should call savecategories() function in easyblogcontroller . i've tried setting value easyblog , easyblog.php (file name) current easyblogcontroller (class name). clicking on save button refreshes page. not redirect, echo or var_dump test code put in savecategories() function. var_dump ing jrequest::getvar('controller') , 'task' return correct values. creating controller object , using $controller->execute('task'); works. the values going depend on location of controller trying call, , have couple options here. typically there controller in base folder of component (likely components/com_easyblog) in file called controller.php , class name inside ...
Read more