tfredrich / RestApiTutorial.com

HTML Source code for www.RestApiTutorial.com
http://www.RestApiTutorial.com
Creative Commons Attribution Share Alike 4.0 International
3.06k stars 1.48k forks source link

Reference OData in the Resources page? #28

Closed dingeins closed 8 years ago

dingeins commented 9 years ago

Hi,

I wonder if it'd be useful for RestApiTutorial.com visitors to reference OData related information in its Resource page.

OData is the short for the Open Data Protocol. It's a open industry standard approved by OASIS (ref: https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=odata). It provides specifications and guidelines about how to build and consume REST APIs (URL conventions, behavioral specifications, schema exposure, control information exposure, etc.).

It represents industry practices as Microsoft, SAP, Salesforce, IBM and etc. are all adopting OData as their REST API guidelines.

For more info about it you may refer to http://www.odata.org/.

tfredrich commented 8 years ago

Thanks for your suggestion. I want to be sensitive to your efforts on OData, but also want to explain a little bit about why I'm choosing not to reference it on the resource page.

REST API best practices follow a resource-driven, design-first approach taking into account the resources, media types and hypermedia relationships involved, carefully ensuring applicability and usability.

OData exposes low-level data tables through HTTP via URLs, largely removing that design-first element. Like any general-purpose tool, it may be useful, but not directly applicable to what we're talking about here.