REST API URI for entities with two different keys -


i must design api manage document entity: originality of entity can have 2 different ids:

  • id1 (number, i.e. 1234)
  • id2 (number, i.e. 89)

for each document, 1 , 1 id available (id1 or id2, not both)

usually solve issue using query parameters perform kind of "search" feature:

get /documents?id1=1234 /documents?id2=89

but works if there no sub-entity...

let's want authors of documents :

get /documents/1234/authors

impossible because can't know type of id get: id1 or id2 ?

get /documents/authors?id1=1234

not rest think because id1 refers "author" entity, not "document" anymore...

get /id1-documents/1234/authors /id2-documents/1234/authors

then create 2 uris return same entity (/author) not rest compliant.

get /documents/id1=1234/authors /documents/id2=89/authors

it looks composite key created api, has no "backend" meaning. me sounds strange create "composite" key on fly.

get /document-authors?id1=1234 /document-authors?id2=89

in case lose notion of tree... end api contains root entities.

do see alternative ? 1 looks best ?

thank much.

it seems me you're conflating 2 different resources here - documents , authors. document has relationship author, should separate resources because authors have existence individual document. in mind need ask whether clients searching authors or documents. if it's authors, should querying authors api rather documents api.

e.g.for authors of documents id1 89 or id1 1234 or id2 4444 might query this...

get /authors?docid1=89&docid1=1234&docid2=4444

that should return list of author representations. if people care documents themselves, author representations contain links documents.

alternatively, if you're looking documents should querying directly...

get /documents?id1=89&id1=1234&id2=4444

what you're modelling sub-resource isn't really subresource. it's relationship between 2 independent resources , should modelled set of links. each document returned documents api should contain set of authors links (if people care authors) , vice versa authors documents.


Comments

Post a Comment

Popular posts from this blog

Is there a better way to structure post methods in Class Based Views -

i'm using class based views in django , never specify url in ajax calls , omit action parameter in form because know these requests go through post method of class based view. notice view - profile page make many requests depending on user updating on page - post method become convoluted , if/else mess example: def post(self, request, *args, **kwargs): # handle user changing available date if request.post.get('availabledate') != none: self.updateavailabledate(request) return jsonresponse({'result':'success'}) if request.post.get('newprojectname') != none: creative_user = creativeuserprofile.objects.get(id = request.user.id) project = project.create_project(creative_user, request.post['newprojectname']) project.save() return jsonresponse({'projectid': project.id }) if request.post.get('projectimage') != none , request.files['file']: proj
Read more

performance - Why is XCHG reg, reg a 3 micro-op instruction on modern Intel architectures? -

i'm doing micro-optimization on performance critical part of code , came across sequence of instructions (in at&t syntax): add %rax, %rbx mov %rdx, %rax mov %rbx, %rdx i thought had use case xchg allow me shave instruction , write: add %rbx, %rax xchg %rax, %rdx however, dimay found agner fog's instruction tables , xchg 3 micro-op instruction 2 cycle latency on sandy bridge, ivy bridge, broadwell, haswell , skylake. 3 whole micro-ops , 2 cycles of latency! 3 micro-ops throws off 4-1-1-1 cadence , 2 cycle latency makes worse original in best case since last 2 instructions in original might execute in parallel. now... cpu might breaking instruction micro-ops equivalent to: mov %rax, %tmp mov %rdx, %rax mov %tmp, %rdx where tmp anonymous internal register , suppose last 2 micro-ops run in parallel latency 2 cycles. given register renaming occurs on these micro-architectures, though, doesn't make sense me done way. why wouldn't register renamer
Read more

jquery - Responsive Navbar with Sub Navbar -

good day, forgive me nav vocabulary not best. if question confusing apologize. i'm working on navigation bar needs centered on page @ 768px , above. items in nav open (or perhaps toggle) subnav lives directly below. these nav should appear centered on page. i have been able work through responsive portion of nav bar, having main items align vertically , sub nav menu of each item roll out below, , gave them indent separation. working well. however, issue not responsive side, behavior @ width greater 768px. happens toggling menu's sub navigation pushes other main items down page below sub nav. here's code: $(document).ready(function () { //stick in fixed 100% height behind navbar don't wrap $('#slide-nav.navbar-inverse').after($('<div class="inverse" id="navbar-height-col"></div>')); $('#slide-nav.navbar-default').after($('<div id="navbar-height-col"></d
Read more