As an example I used the Google translation API, pointed out its good points and explained what I'd love to see added to it. Specifically any JavaScript Ajax API to me should have the following:
* Have a good documentation with immediate copy and paste examples backed up by a full class documentation
* Build your APIs modular and allow the implementer to choose the version they want to have
* Provide a hook to link the result of the API methods to the initial data entered. The easiest way is to repeat this data, more sophisticated is to allow for a connection ID.
* Allow for multiple values to be sent through, it’ll save you API calls and the implementer hacking around the problem of unreliable order of returns.
* Allow implementers to add an own object to send and get back to allow for namespacing and other data state retention.
* Allow for a timeout, connections are not to be trusted.
Read Full Story at http://www.wait-till-i.com
Discuss
Tell a friend
Bookmarks
apis
usability
dataportability
ajax
Dreamer
submitted 190 days ago
My wishlist for a great Ajax API
Following discussions at the Highland Fling conference with the audience and Gareth Rushgrove (whose excellent presentation on API design we featured here already) I sat down and came up with a wishlist for a great Ajax API.
As an example I used the Google translation API, pointed out its good points and explained what I'd love to see added to it. Specifically any JavaScript Ajax API to me should have the following:
* Have a good documentation with immediate copy and paste examples backed up by a full class documentation
* Build your APIs modular and allow the implementer to choose the version they want to have
* Provide a hook to link the result of the API methods to the initial data entered. The easiest way is to repeat this data, more sophisticated is to allow for a connection ID.
* Allow for multiple values to be sent through, it’ll save you API calls and the implementer hacking around the problem of unreliable order of returns.
* Allow implementers to add an own object to send and get back to allow for namespacing and other data state retention.
* Allow for a timeout, connections are not to be trusted.
Read Full Story at http://www.wait-till-i.com
Discuss
Tell a friend
Bookmarks
apis
usability
dataportability
ajax
Dreamer
submitted 190 days ago
| Related sources | ||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
| Comments |
Log in to comment or register here.