API Versioning

There are mixed opinions on whether version numbers should exist in an API's URL.

Has a consensus been reached within other areas of Thomson Reuters technology on how best to do this?

Find more posts tagged with

api

refinitiv-internal

Accepted answers

paul.buchanan.1

Yes, you should place a version number in your REST endpoints. This allows you to later change your contract by incrementing the version number while still maintaining backwards compatability by keeping the existing version. Easy versioning is a huge benefit of REST over SOAP, and should be used. The version number should be the first item in the path after the module:

http://host/module/{version ie v1}/endpoint

[Here](https://thehub.thomsonreuters.com/docs/DOC-69062) are some guidelines on when to increment your version number.

All comments

Ryan Morlok

I think most modules use versioning of the /vX/: http://host/module/vX/endpoint

e.g. http://webcontent.int.advisor.accelus.com/WebContent/v2/documents

I know Search, WebContent, Foldering and Document all do this. Website is more of a gray area. My understanding is that URLs that are user visible (in the address bar) are not versioned, REST APIs are.

paul.buchanan.1

EXPLORE OUR SITES