Hi Ivo, 2011/11/15 Ivo Ladage-van Doorn <[email protected]>: > Hi All, > > As REST is our primary API, we need to come up with a convention on how to > implement these REST services. Therefore I uploaded a first proposal to this > WIKI page: > > http://www.amdatu.org/confluence/display/Amdatu/REST+guidelines > > Please read the guidelines and provide your feedback. Once we approved upon > these guidelines, we can/could update existing REST API’s to conform to > these new conventions.
First impressions are good. I think, at least up to chapter 2.7, this is a proper set of REST rules and common design principles also found in other well known RESTful services. Some remarks/questions with regard to... <quote> 2.7 Authentication For all protected services, OAuth where the OAuth parameters are send using the “Authorization” HTTP header is the preferred method of authentication and SHOULD be implemented </quote> I am not sure what this implies? In general I'd say that authentication is an aspect, not part of the (REST) interface design and the implementation should certainly not be aware of the authentication scheme/implementation. <quote> 2.8 API Versioning When an API change is not backwards compatible, a new version of the API MUST be created by adding the API version after the base in the resource URI, e.g. /rest/users/2.0.0/001. By default, /rest/users/001 represents the 1.0.0 version of the API. </quote> I don not understand this scheme :S Is it a typo or is it me? :) Regards, Bram _______________________________________________ Amdatu-developers mailing list [email protected] http://lists.amdatu.org/mailman/listinfo/amdatu-developers
