t2trg / t2trg-rest-iot

RESTful Design for Internet of Things Systems
3 stars 4 forks source link

Guidance on resource design #9

Open mkovatsc opened 8 years ago

mkovatsc commented 8 years ago

What should be a resource? (cf. object-oriented design; state, not actions) Size of resources (to many properties in one resource vs. to many roundtrips)

mkovatsc commented 8 years ago

Mike Amundsen:

Section 3.4 I think most of the text here can be removed and replaced with a reference to existing RFCs on URI (e.g. 3986). I think it would also be good guidance to reference RFC7320 ("URI Design and Ownership")[3].

The definition of URIs and design of resources is closely related.

mkovatsc commented 7 years ago

Also include text from http://www.jopera.org/files/SOA2009-REST-Patterns_0.pdf

mkovatsc commented 7 years ago

Include information on parents/children: resources are not implicitly related through the URI path, but only though explicit links. (The designer of the server namespace (resources) usually picks a logical structure and co-humans can easily guess that logic, but they mustn't).

akeranen commented 7 years ago

To the guidelines before the design patterns. Think about state instead of interaction.