Why web services versioning is important

Freshness Warning
This article is over 13 years old. It's possible that the information you read below isn't current.

Two words: client synchronization.

Talking to Bill Lazar, he suggested that my web serrvices versioning problems are similar to his problems with Ruby on Rails. He’s got some code running on a pre-1.0 RoR installation. With 1.0, several important constructs changed in the framework, and upgrading to 1.0 would break his application. As we chatted through this, we hit upon the key difference. Although RoR released 1.0, there’s nothing forcing him to actually use it. He can keep using 0.9 (or whatever version he has) as long as he wants. He can try his code on a 1.0 system elsewhere, test it, adjust it, and prepare it for use. Then when he’s ready, he can upgrade his code and his RoR installation at the same time. The version negotiation between the client and server can be planned and synchronized.

For a data structure or service delivered over the public web to a disparate set of clients, this isn’t possible. I cannont time the upgrade of the server to co-incide with an upgrade of the client. In many cases, I don’t even know who the client is. I certainly don’t control them. And even if I knew them all, synchronizing an upgrade would require that I coordinate the upgrade schedules of multiple clients, maintained by multiple people, with varying degrees of interest and need.

The essential component in Bill’s Rails upgrade is a time shift. The RoR framework was released, but Bill can choose when it applies to him by shifting the upgrade to a time that suits him. People that need it now, or are just starting out with Rails can get the 1.0 version immedately. Everyone else can use whatever version they want. The Rails team doesn’t need to maintain old versions of the application. It’s acceptable to say that bugs in the app are fixed in the later versions only and if you have a problem that needs fixing, you should accelerate your upgrade schedule.

With a web service, I can time shift the upgrade path by continuing to supply older versions of the data format. There’s no maintenance involved. The format sits there, and anyone connecting to it can use it. If someone has a problem or needs some new data, they can get it by moving to the newest version. Any new uses of the service start out with the latest version.


Your comments:

Text only, no HTML. URLs will automatically be converted to links. Your email address is required, but it will not be displayed on the site.

Name:

Not your company or your SEO link. Comments without a real name will be deleted as spam.

Email: (not displayed)

If you don't feel comfortable giving me your real email address, don't expect me to feel comfortable publishing your comment.

Website (optional):

Follow me on Twitter

Best Of

  • How not to apply for a job Applying for a job isn't that hard, but it does take some minimal effort and common sense.
  • Movie marketing on a budget Mark Cuban's looking for more cost effective ways to market movies.
  • California State Fair The California State Fair lets you buy tickets in advance from their Web site. That's good. But the site is a horror house of usability problems.
  • Customer reference questions. Sample questions to ask customer references when choosing a software vendor.
  • Comment Spam Manifesto Spammers are hereby put on notice. Your comments are not welcome. If the purpose behind your comment is to advertise yourself, your Web site, or a product that you are affiliated with, that comment is spam and will not be tolerated. We will hit you where it hurts by attacking your source of income.
  • More of the best »

Recently Read

Get More

Subscribe | Archives

Recently

Assumptions and project planning (Feb 18)
When your assumptions change, it's reasonable that your project plans and needs change as well. But too many managers are afraid to go back and re-work a plan that they've already agreed to.
Feature voting is harmful to your product (Feb 7)
There's a lot of problems with using feature voting to drive your product.
Encouraging 1:1s from other managers in your organization (Jan 4)
If you’re managing other managers, encourage them to hold their own 1:1s. It’s such an important tool for managing and leading that everyone needs to be holding them.
One on One Meetings - a collection of posts about 1:1s (Jan 2)
A collection of all my writing on 1:1s
Are 1:1s confidential? (Jan 2)
Is the discussion that occurs in a 1:1 confidential, even if no agreed in the meeting to keep it so?
Skip-level 1:1s are your hidden superpower (Jan 1)
Holding 1:1s with peers and with people far below you on the reporting chain will open your eyes up to what’s really going on in your business.
Do you need a 1:1 if you’re regularly communicating with your team? (Dec 28)
You’re simply not having deep meaningful conversation about the process of work in hallway conversations or in your chat apps.
What agenda items should a manager bring to a 1:1? (Dec 23)
At least 80% of a 1:1 agenda should be driven by your report, but if you also to use this time to work on things with them, then you’ll have better meetings.

Subscribe to this site's feed.

Contact

Adam Kalsey

Mobile: 916.600.2497

Email: adam AT kalsey.com

Twitter, etc: akalsey

Resume

PGP Key

©1999-2019 Adam Kalsey.