Version

This document covers information about requesting a specific version of the API

πŸ‘

TL;DR

Wherever we need versioning, we make use of Semantic Versioning 2.0.0. So this applies to the wunderbon API as well. If you are interested in further information on Semantic Versioning 2.0.0 have a look here. We combine all releases under a major version to e.g. v1 or v2 and so on. So we roll out backwards compatible additions and bug fixes under an already public version until we decide to release a new major version.

By default, all requests to https://api.wunderbon.io receive the latest version of the API. wunderbon encourages you to explicitly request this version via the Accept header. For an overview of the wunderbon API versions provided, see changelog.

6464

Accept Header

To prevent any side effects, we really encourages you to request a specific version. Future versions may behave differently on major version updates.

Example behavior by version upgrade:

  • Major: Any breaking API changes
  • Minor: Additions of new features or functionality that are backwards compatible
  • Patch: Bugfixes

With the Accept header, you can address a concrete version of the wunderbon API. Have a look at the following example:

Accept: application/vnd.api.v1+json

Please have in mind that we combine the Content-Type here with the wunderbon API version field in one Accept Header. For the case above, this is application/vnd.api+json and v1

URL

If you prefer to request a specific version by URL you can define the version like in the following example:

https://playground-api.wunderbon.io/v1/users

Without passing the version with the URL you would request the latest version like in this example:

https://playground-api.wunderbon.io/users

What’s Next

Continue with our guided tour. Now, we would like to tell you more about data models and our Single Source Of Truth approach ...