Tag Archives: API

Getting an API right

Having worked on Huddle’s API, and my own now for some time, I’ve come across plenty of mistakes along the way. Having said that I thought I’d release a few pointers of what I’ve learnt.

REST over SOAP. Ok SOAP has its uses, but come on, it can be such a pain. We used it previously, [...]

Creating API documentation

We’ve recently been working on our API and came across the problem of writing documentation for the API.
Having looked at a number of solutions I came up with a simple solution using XML comments within C# and the XML generated by the project during compilation. Here are the steps:

For any exposed API methods you write, [...]