The Design of Software (CLOSED)

A public forum for discussing the design of software, from the user interface to the code architecture. Now closed.

The "Design of Software" discussion group has been merged with the main Joel on Software discussion group.

The archives will remain online indefinitely.

exposing an API

we are developing a web based application.Some features,we would like to expose using an API.Can API be exposed using different protocols like webservice,http post.Or one should concentrate on exposing API based on a single protocol.
Friday, August 10, 2007
Make sure that the API is broken down into two parts: 1) the message format/layout, and 2) the communications/protocol. You should design it so that the communications portion can support multiple protocols (http, sockets, etc.) while maintaining the same message layouts.

Ultimately, you will just need to choose your first supported communications protocol (go for something more standard) and go with that. But a good design should allow you to add new protocols as the need arises.
dood mcdoogle
Saturday, August 11, 2007
Google up on REST and RESTful APIs. They may not be appropriate for all business situations, and it may be hard to see how to apply them to your own services right off, but they can lead to simplicity and ease of use.

I'm just using JSON for the first time as an experiment. In some places it can be a neat alternative to XML or other message encoding schemes, especially when one or both ends of the conversation are JavaScript.
Stan James Send private email
Saturday, August 11, 2007
+1 for REST...
Totally Agreeing
Sunday, August 12, 2007
In my uISV ( b2b sales forecasting ), we are heavily relying on our Web Services API ( ).

In my experience, the key issues with API are not really the technology (REST, SOAP, ... ) but rather
- the quality / meaningfulness of the design.
- the stability of the design.
- the documentation and tutorials.

For the last point, we have open sourced all API connectors ( ).

Hope it helps,
Joannes Vermorel Send private email
Monday, August 13, 2007
Does anybody have a good reference for a REST noob?  I Googled it, but what comes up on the Google result isn't always the best reading material.  Thanks.
Monday, August 13, 2007

This topic is archived. No further replies will be accepted.

Other recent topics Other recent topics
Powered by FogBugz