Advanced Configuration

Below you will find some additional techniques and methods for tweaking your BeAPI implementation.

Versioning

The version for your api is sent through the URL but is set in two different places. Let's first break apart the URL version:

http://localhost:8080/v1.0-1/person/create

In the above example, the version is v1.0-1. This is broken out into three parts:

  • [v]1.0-1: The 'v' determines what kind of call it is whether it is a batch call(b), a chained call(c) or a regular api call(v)
  • v[1.0]-1: This is the version of the application (as set by the application); this helps us to run multiple versions of the application should we need to.
  • v1.0[-1]: This is the version of the IO State. It always defaults to '1' if this is not set (which it doesn't need to be). This allows you to have multiple version of your api rules running should you need to support older versions while running newer versions on the same application. Supports up 1-9 versions on any existing application for any IO State file

Calling Without Version

This is the most common call you will make... which is without any particular version (to the default version in the IO State). This would look like the following:

http://localhost:8080/v1.0/person/create


Calling With Version

If you have a particular version you wish to call (and you know it is supported via documentation), simply call that version of the endpoint like so:

http://localhost:8080/v1.0-1/person/create


Calling With App Version

If you are running separate application versions and are properly routing based on app version, simply call the different app version like so:

http://localhost:8080/v0.5/person/create

... or like so:

http://localhost:8080/v0.5-1/person/create