Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add chapter on client-controlled resource representation #24

Open
hlgr360 opened this issue Jan 16, 2017 · 0 comments
Open

Add chapter on client-controlled resource representation #24

hlgr360 opened this issue Jan 16, 2017 · 0 comments

Comments

@hlgr360
Copy link
Contributor

hlgr360 commented Jan 16, 2017

From a convo on mantis-api channel:

One of the most important design principles for an API program is to embrace that APIs are products. It follows that successful APIs, much like products, must provide user-optimized experiences. Case in point: it is clearly inappropriate to send a mobile application large response payloads. Your API may get away with it when responding to a request from an enterprise system communicating over a high-speed fiber-optic connection. Some clients may even want to get a rich response, but in general assuming that network is reliable and/or bandwidth is infinite is a fallacy, on the web.

  • especially read the comment section
    http://spec.transclude.io
    spec.transclude.io
    Transclude Preference for the HTTP Prefer Header
    The specification for Transclude preference is an extension to the Prefer Header for HTTP
    is referred there

Transclude preference notifies the server that the client would prefer the server to proactively transclude certain content represented by links of indicated link relation types. The notion of "link relation type", in this context is as defined by [RFC5988].
I really like that concept .. and it provides some means of the client controlling the scope of the resource representation .. which i think your main question was

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant