Marek Pietrzak marek-pietrzak-tg

API versioning for HTTP REST interfaces (best practices)

We at SCC Team (and at SUSE in general) are providing more and more APIs with the wonderful HTTP REST approach. APIs evolve over time, often unexpectedly — so it makes sense to get into some API versioning best practices right from the day 0. I was asked to join Crowbar guys' discussion to share my SCC experience with versioning APIs. This article is an attempt to formalize our solution and prepare it for a wider audience.

So, imagine you have different API consumers out of your area of control. Some of them definitely will lag behind the latest release.

	# If you use bash, this technique isn't really zsh specific. Adapt as needed.
	source ~/keychain-environment-variables.sh

	# AWS configuration example, after doing:
	# $ set-keychain-environment-variable AWS_ACCESS_KEY_ID
	# provide: "AKIAYOURACCESSKEY"
	# $ set-keychain-environment-variable AWS_SECRET_ACCESS_KEY
	# provide: "j1/yoursupersecret/password"
	export AWS_ACCESS_KEY_ID=$(keychain-environment-variable AWS_ACCESS_KEY_ID);
	export AWS_SECRET_ACCESS_KEY=$(keychain-environment-variable AWS_SECRET_ACCESS_KEY);

	<?php

	namespace Widop\Mink\Extension;

	/**
	* Dictionary to manage popups.
	*
	* @author Benjamin Lazarecki <[email protected]>
	*/
	trait PopupDictionary