How to construct intersection in REST Hypermedia API? -


this question language independent. let's not worry frameworks or implementation, let's can implemented , let's @ rest api in abstract way. in other words: i'm building framework right , didn't see solution problem anywhere.

question

how 1 can construct rest url endpoint intersection of 2 independent rest paths return collections? short example: how intersect /users/1/comments , /companies/6/comments?

constraint

all endpoints should return single data model entity or collection of entities.

imho reasonable constraint , examples of hypermedia apis this, in draft-kelly-json-hal-07.

if think invalid constraint or know better way please let me know.

example

so let's have application has 3 data types: products, categories , companies. each company can add products profile page. while adding product must attach category product. example can access kind of data this:

  • get /categories return collection of categories
  • get /categories/9 return category of id 9
  • get /categories/9/products return products inside category of id 9
  • get /companies/7/products return products added profile page of company of id 7

i've omitted _links hypermedia part on purpose because straightforward, example / gives _links /categories , /companies etc. need remember using hypermedia traversing relations graph.

how write url return: products company(7) , of category(9)? in otherwords how intersect /categories/9/products , /companies/7/products?

assuming endpoints should represent data model resource or collection of them believe fundamental problem of rest hypermedia api, because in traversing hypermedia api traversing relational graph going down 1 path impossible describe such intersection because cross-section of 2 independent graph paths.

in other words think cannot represent 2 independent paths 1 path. traverse 1 path a->b->c, if have x->y , z->y , want ys come x , z have problem.

so far proposition use query strings: /categories/9/products?intersect=/companies/9 can better?

why want this?

because i'm building framework auto-generate rest hypermedia api based on sql database relations. think of trans compiler of urls select ... join ... where queries, client of api sees hypermedia , client have nice way of doing intersections, in example.

i don't think should @ rest database representation, case looks more of kind of specific functionality me. think i'd go this:

/intersection/comments?company=9&product=5

i've been digging after wrote , i've found (http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api):

sometimes have no way map action sensible restful structure. example, multi-resource search doesn't make sense applied specific resource's endpoint. in case, /search make sense though isn't resource. ok - what's right perspective of api consumer , make sure it's documented avoid confusion.


Comments

Post a Comment

Popular posts from this blog

resizing Telegram inline keyboard -

telegram's inline keyboard great feature lots of different use cases. inline buttons added list of items this: inline_keyboard = [[inlinekeyboardbutton(text="button", callback_data="button"), inlinekeyboardbutton(text="reset",callback_data="reset")]] inline_keyboard_markup = inlinekeyboardmarkup(inline_keyboard) update.message.reply_text("hi", reply_markup=inline_keyboard_markup) the above code adds 2 buttons each half width of chat screen. i know the normal keyboard button there resize_keyboard parameter somehow can used. my question is there way resize inline buttons ? example make full width or quarter width. unfortunately, can't now. :( you can suggest @botsupport , might add feature next version.
Read more

recursion - Can every recursive algorithm be improved with dynamic programming? -

i first year undergraduate csc student looking competitive programming. recursion involves defining , solving sub problems. understand, top down dynamic programming (dp) involves memoizing solutions sub problems reduce time complexity of algorithm. can top down dp used improve efficiency of every recursive algorithm overlapping sub problems? dp fail work , how can identify this? the short answer is: yes. however, there constraints. obvious 1 recursive calls must overlap. i.e. during execution of algorithm, recursive function must called multiple times same parameters. lets truncate recursion tree memoization. can use memoization reduce number of calls. however, reduction of calls comes price. need store results somewhere. next obvious constraint need have enough memory. comes not-so obvious constraint. memory access requires time. first need find result stored , maybe copy location. in cases, might faster let recursion calculate result instead of loading somewher...
Read more

javascript - How to bind ViewModel Store to View? -

i'm pretty new ext js , trying embed multiselect inside panel . the viewmodel has stores property can see here: ext.define('test.view.controls.search.searchfiltermodel', { extend: 'ext.app.viewmodel', alias: 'viewmodel.filter', data: { title: '' }, stores: { test: { fields: [ 'id', 'name' ], proxy: { type: 'ajax', url: 'api/test', reader: 'array' }, autoload: true } } }); i bind in view this: viewmodel: { type: 'filter' }, layout: 'fit', border: 1, plain: true, scrollable: 'y', layout: 'fit', bind: { title: '{title}', }, items: { xtype: 'multiselect', scrollable: false, allowblank: true, ddreorder: true, bind: { store: '{test}' }, valuefield: 'id', displayfield: 'name' } ...
Read more