REST API Accept header json/pdf -

-

i'm working api, think doing wrong implementation of rest api.

we have following endpoints

  1. get v1/{organizationid}/invoices
  2. get v1/{organizationid}/invoices/{guid}

when first, invoices, if second endpoint, without accept: application/json header, response first endpoint instead.

the company, provides api, says reason because second endpoint can give both json , pdf output, seem pdf be

get v1/{organizationid}/invoices/{guid}/pdf

besides that, if send malformed guid, full blown html 404 error page instead of, e.g., blank page or error message.

to sum up

  1. is 2. endpoint handled properly?
  2. is valid make pdf output json/xml?
  3. shouldn't new endpoint instead?
  4. is html allowed error response, malformed request?

some people don't categorize rest-based questions "right" , "wrong", go ahead anyway:

  1. no, second resource should return representation of second resource, is, invoice, never collection of invoices.

  2. yes, ok potentially return multiple representations of same "thing". invoice can conceivably return both json , pdf, , can select correct 1 based on "accept" header.

  3. no, shouldn't new "endpoint", because these "things" not "endpoints", resources. invoice resource, json document "representation" of resource.

  4. yes, error response can contain body, whatever representation server comfortable sending. server should of course orient using "accept" header client, not required so.

a few remarks: should not possible get invoice wrong guid, since these resources should linked collection resource. when client follows links (as should), there should no way follow link wrong guid.

it wrong return different resource (invoice collection instead of invoice), ok have multiple representations of same resource. if there no "accept" header, server should pick one, or indicate 406 not acceptable.

one small point: mime-type should not application/json, because how know it's invoice then? should like: application/vnd.someprovider.invoice+json. no 1 bothers mime-types these days, mention completeness sake.


Comments

Post a Comment

Popular posts from this blog

java - Static nested class instance -

-
this question has answer here: java inner class , static nested class 23 answers i came across in java, know static nested class why create instance of 'static'. isn't whole idea of 'static' use without instance? understand concept of inner classes, why (and frankly how possible to) create 'instance' of 'static' member @ ? why this: 1- outerclass.staticnestedclass nestedobject = new outerclass.staticnestedclass(); 2- nestedobject.anestedclassmethod(); and not this: 1- outerclass outerinstance=new outerclass(); 2- outerinstance.staticnestedclass.anestedclassmethod(); use on inner classes, keyword static indicates can access inner class without instance of outer class. for example: public class outer { public static class inner { /* code here. */ } } with construction, can create instance of inn
Read more

c# - Bluetooth LE CanUpdate Characteristic property -

-
i building xamarin.forms cross platform mobile app, uses monkey.robotics bluetoth low energy functionality. connecting mbed based implimentation of custom gatt service . in xamarin c#, triggers characteristic. canupdate property in monkey.robotics? this standard example c# based on: if (characteristic.canupdate) { characteristic.valueupdated += (s, e) => { debug.writeline("characteristic.valueupdated"); device.begininvokeonmainthread( () => { updatedisplay(characteristic); }); isbusy = false; // spin until first result received }; isbusy = true; characteristic.startupdates(); } this has been working, since changed own custom gatt service connecting to, canupdate property false. property , how triggered? me debugging gatt service code. thanks monkey.robotics open sour
Read more

JavaScript - Replace variable from string in all occurrences -

-
ok, know if have character '-' , want remove in places in string javascript, ... someword = someword.replace(/-/g, ''); but, when applying array of characters, s not working ... const badchars = ('\/:*?"<>|').split(''); let filename = title.replace(/ /g, '-').tolocalelowercase(); (let item = 0; item < badchars.length; item++) { // below not work global '/ /g' filename = filename.replace(/badchars[item]/g, ''); } any ideas? /badchars[item]/g looks badchars , literally, followed i , t , e , or m . if you're trying use character badchars[item] , you'll need use regexp constructor, , you'll need escape regex-specific characters. escaping regular expression has been well-covered . using that: filename = filename.replace(new regexp(regexp.quote(badchars[item]), 'g'), ''); but , don't want that. want character class: let filename = title.replac
Read more