My company is reworking its API and wants to make everything RIGHT for this time ;) Thats the setup...
- We are delivering data to clients over the internet.
- Clients are mobile handsets like iPhone, Androids, J2ME, Blackberry...
- The server is coded in Ruby on Rails
We want to achieve through a framework...
- Take use of ActiveResource on the clients.
- The framework should do the connection (REST), parsing and (dynamically) providing of models
- Licence must be open source.
- Authorization shall be included. We use OAuth and need to deliver the Access Token on any request. Maybe as parameter or in the HTTP-Header?
- HTTPS/SSL support
- Pagination and Relationships (with lazy loading) support would be great! Otherwize the framework must be able to be adjusted for these things.
We already have found following frameworks and kindly ask you guys to evaluate them. Maybe one of you used some of them or something different...
- Android: Hand made approach with the use of cursors backed by a SQLLite DB
- intended to be very performant and best practice of Android
- uses cursors
- Android: Spring Android Rest Template Module
- Spring's RestTemplate is a robust, popular Java-based REST client. The Spring Android Rest Template Module provides a version of RestTemplate that works in an Android environment.
- Android: You always should take a look at this video of Google IO 2010 when thinking serious about REST
- Android: Feed Framework
- com.google.android.feeds
- A collection of classes to help you build content providers. The framework is specially designed to help connect your application to Web APIs.
I am the author of the RESTProvider. Still very early stage so I would not recommend to use it in production. I have been using it on several projects which are in production but I adapted most the code to specific needs. I will try to get a public stable API by the end of the year.
In regards to reworking the API, I would suggest the following:
- Use GZip compression
- Use ETags for caching
- Use standards with no modification (I saw cases where the naming changed from oauth_token to my_token which makes most library useless without modification) - OAuth/REST
- Use creation/modified timestamp and remote ids for all objects in order to enable caching client side (SQLite conflict clauses):
{"myobject": {"createdAt": xxxx, "rid": "hashvalue"}}
4a. Use a good way to identify the object returned for user/activity/application: opensocial uses "application id" + "user id" + "activity id"
- Prefer JSON over XML
- Prefer simplicity (lowest depth possible)
- Return the full object with the one to many relationship within that object:
{"parent":....
"has": {"full object not just the ID"}
}
- Don't return IDs only ( "category": [ 2,3,4] should be "category": [{"name": "testing", "id": 2},{"name": "production", "id": 3 }} )
- Consider each call to be independent of each other (i.e. I should have enough information for call http://test.com/object.json to populate my views)
For documentation:
1. provide test servers
2. provide cUrl for testing
3. provide sample scripts in java/php/ruby etc...
That s all I can think for now. I might add ontop of this as I come with more suggestion.
I'd recommend taking a look at RestKit for iOS
- High performance, threaded network layer with a simple API for request/responses
- Object mapping system for mapping remote payloads into local objects declaratively (including relationships)
- Integration with Core Data for providing a fast local cache of remote data with synchronization capabilities
- Support for generating a seed database from a series of JSON payloads
- Specific support for integrating with Ruby on Rails backends (RKRailsRouter)
- Apache licensed
- Used in production in a number of excellent apps (i.e. Gate Guru)
Menu
742
