Difference between revisions of "Versioning"

From MyMobileWorkers API
Jump to: navigation, search
(→‎Example URL Formatting)
 
Line 1: Line 1:
−
The API will evolve over time and as development progresses we maintain previous versions of the API a long side the latest code so we do not break any functionality on existing integration tools.
+
The API will evolve over time with new endpoints and data added. In the event that we make a "breaking change" to the API, we will maintain the prior functionality.
  
−
Part of the URL for each call will contain a version that reflects the api version used. Each new version of the API will see the version number increase it is recommended you use only the latest version when developing.
+
To enable this, part of the URL for each call contains a version number that reflects the API version used. This is currently 1.
 +
 
 +
As development progresses we will maintain previous versions of the API alongside the latest code so we do not break any functionality on existing integration tools.
 +
 
 +
It is recommended you use only the latest version when developing.
  
 
=== Example URL Formatting ===
 
=== Example URL Formatting ===
  
 
http://api.mymobileworkers.com/api/:version/:resource/...
 
http://api.mymobileworkers.com/api/:version/:resource/...

Latest revision as of 17:42, 13 December 2016

The API will evolve over time with new endpoints and data added. In the event that we make a "breaking change" to the API, we will maintain the prior functionality.

To enable this, part of the URL for each call contains a version number that reflects the API version used. This is currently 1.

As development progresses we will maintain previous versions of the API alongside the latest code so we do not break any functionality on existing integration tools.

It is recommended you use only the latest version when developing.

[edit] Example URL Formatting

http://api.mymobileworkers.com/api/:version/:resource/...

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox