api - RESTful web service: create new resource by combining other resources: provide IDs or URIs? -



api - RESTful web service: create new resource by combining other resources: provide IDs or URIs? -

when obtaining collection of items restful web service (via get), representation of each single item (e.g. in json) contains item's resource identifier. can either id of resource or entire uri contains id.

this identifier (id or uri) required in case client needs farther interact remote resource representing single item. many people seem consider practice provide entire uri , not id, client has nil uri construction (for example, miguel grinberg writes in this article).

but should done in case multiple items combined in order create new resource? client needs tell server items combined. , eventually, server requires list of ids processing request. assuming client retrieved uris each item in first place -- perform uri parsing in order extract raw ids again: in client or in server?

example: client retrieved collection of pages in request. each page item identifies uri (containing id):

{ "pages": [ { "content": "bla bla", "uri": "/pages/1" }, { "content": "that no interesting content", "uri": "/pages/2" }, ... ] }

now assume client instructs server create new resource combining multiple pages: book, built pages 1 , 2. post request body can either contain ids or uris:

{ "title": "a boring book", "pages": [1, 2] }

or

{ "title": "a boring book", "pages": ["/pages/1", "/pages/2"] }

in first case, clients needs know construction of uri , extract id before sending request. in sec case server needs extract id uri.

on 1 hand, thought of resources beingness represented on client side uris only. on other hand, maintain things simple , pragmatic , why should send entire uris server when context clear , ids needed (the book creation not straight deed on page resources)?

what prefer , why? or think not important?

do think next approach compromise? client-side extraction of id uri parsing uri right left , extracting number after rightmost slash, i.e. assuming uri construction without need hardcode entire path.

i think clients should receive absolute urls server , utilize these without kind of modification. therefore, go 1 step farther beyond lastly example:

{ "title" : "a boring book", "pages" : [ "http://.../pages/1", "http://.../pages/2" ] }

only server should responsible extract ids urls if necessary.

api rest uri restful-url restful-architecture

Comments

Post a Comment

Popular posts from this blog

xslt - DocBook 5 to PDF transform failing with error: "fo:flow" is missing child elements. Required content model: marker* -

xslt - DocBook 5 to PDF transform failing with error: "fo:flow" is missing child elements. Required content model: marker* - i've inherited doc publishing process takes docbook , builds html , pdf output, using apache fop both. project had been started, never completed. lots of tweaking, i've able of doc sets build (20+), except handful, , fail severe code 1 of these 2 conditions: "fo:flow" missing kid elements. required content model: marker* "fo:block" not valid kid of "fo:root" the xml output comes out of docbook , docbook-fop checks out well-formed. the fop error in 1 book, "endecagloss", example, points end of string: <fo:flow flow-name="xsl-region-body" start-indent="4pc" end-indent="0pt"/> here’s log output in case: [java] severe: javax.xml.transform.transformerexception: file:/scratch/publishing/hudson/jobs/build-main-endeca-documentation/workspace/serverdoc/w...
Read more

mediawiki - How do I insert tables inside infoboxes on Wikia pages? -

mediawiki - How do I insert tables inside infoboxes on Wikia pages? - i want insert tables in infoboxes. example, have proteinbox i've developed using infobox template (http://health-and-medicine.wikia.com/wiki/template:proteinbox), , fasta field big fit comfortably in proteinbox. hence collapsible table within box. this tried: {{infobox | row 1 = {| class = "mw-collapsible mw-collapsed wikitable" |- | <!-- table content --> |} }} your problem is, putting nested table within template. pipe characters ( | ) in table syntax collides pipe usage in templates. the commonly used hack around create template called template:! , containing pipe character, , utilize when need set tables, parser functions or other stuff using pipe characters, within templates. table (with every | replaced {{!}} ): {{{!}} {{!}}- {{!}} a1 {{!}} b1 {{!}}- {{!}} a2 {{!}} b2 {{!}}} ...the equivalent of {| |- | a1 | b1 |- | a2 | b2 |} furthermore, hav...
Read more

Local Service User Logged into Windows -

Local Service User Logged into Windows - i created windows service tracks app server user connected through load balancer. it retrieves user logged windows on machine, cross references active directory (ad) business relationship homecoming first name, lastly name , e-mail (for notification through website created project) there 1 scheme on network users remote system, vista system, reason returning values "local service" logged machine, it's weird , security guys impossible "local service" business relationship logged windows. here how user logged windows managementscope ms = new managementscope("\\\\.\\root\\cimv2"); objectquery query = new objectquery("select * win32_computersystem"); managementobjectsearcher searcher = new managementobjectsearcher(ms, query); foreach (managementobject mo in searcher.get()) { _username = mo["username"].tostring(); } // remove domain part username string[] usernameparts = _...
Read more