2.8 Keep it SimpleApril 15th, 2009 — Marieke Guy
When working with APIs it makes sense to start simple and build up. Think about the resources implications of what you are doing. For example build on top of existing libraries: Try and find a supported library for your language of choice that abstracts away from the details of the API. Wrap external APIs, don’t change them as this will be a maintenance nightmare. The exception here is if your changes can be contributed back and incorporated into the next version of the external API. APIs often don’t respond the way you would expect, make sure you don’t inadvertantly make another system a required part of your own.
“Some things don’t behave as expected: Last.fm Geo API didn’t find many UK cities!“
When working with new APIs give yourself time. Not all APIs are immediately usable. Try to ensure that the effort required to learn how to use APIs is costed into your project and ensure the associated risks are on the project’s risk list.
Some Web developers lean towards consuming lean and RESTful API’s however this may not be appropriate for your particular task. SOAP based APIs are generally seen as unattractive as they tend to take longer to develop for than RESTful ones. Client code suffers much more when any change is made to a SOAP API.
“You can bind to Web services in ASP.NET, resulting in a proxy class you can manipulate with managed code. Planning how to organize these beforehand, with appropriate naming conventions, would be helpful.“