Ensure used Service Library is deployed to Host

Before setting a used service relation and before you can use the service library, you need to generate the library and deploy it to the Innkeeper service, which acts as a Maven repository for the artifacts.

To do this, you either can use the Dashboard functionality under Components > Services > Deploy Library or you just need to call the following Brewer REST endpoint:cURL

Once the library has been successfully generated and deployed, you can set the used service relation.
There are different ways to do this:

Option A) Automatic via Brewer-Maven-Plugin

The Brewer Maven plugin is a tool providing custom Maven goals that helps you to operate with your generated local service project. Amongst other things it provides you the addDependency goal in order to automatically do all the changes needed to add a used service as dependency.

To add a new used service dependency to your local generated service project you basically just need to call the following command within your service project's root directory:

This will not only add the correct used service dependency to your pom.xml but also add the necessary configuration changes to your local project. Afterwards just update your local Maven project to retrieve all the needed dependencies like the usedService library.

You can now start to use the used service API client's and later deploy your finish implementation by calling mvn deploy (see Brewer Maven plugin documentation for more details).

Option B) Semi-Automatic via REST

This alternative option to create a used service relation between two services is to call a specific YAMBAS REST endpoint. Afterwards, the generated service project will contain all the project files you need.
However this is not supported under the following circumstances:

• You already deployed your generated service to Innkeeper and downloaded it without setting the flag merge=false

• You have your sources locally and downloaded the service via the brewer:download Maven goal

The reason for that behaviour is that we don't overwrite all files in this semi-automatic operation (such as pom.xml or application.yml) to give you more freedom during development.
Therefore, you'd have to download the generated service using the merge=false flag and manually merge the changes in pom.xml and application.yml, or adapt the files manually according to option C (see below).

To set a used service relation via REST, use the following YAMBAS endpoint:cURL

To remove a used service relation, use the following REST endpoint:cURL

Once the used service relation is set, you need to trigger the first generation of the service either by using the build action in the Dashboard or by calling Brewer's service generation REST endpoint (see step 5 in the Tutorial "Model your Service" or go to Brewer's usage documentation).
After generating and downloading your service, you can continue with integrating it into your IDE and skip option C to progress with the next section.

Option C) Manually

This section contains the steps you need to do manually which are done automatically in the previous options. In general, you just need to add the used service as a library dependency to the POM of your service and configure some Spring project features.
But let's go into detail:

apiomat:
  service:
    discovery:
      uses:
        {USED_SERVICE_NAME}:
	      name: {{USED_SERVICE_NAME}}
	      version: "[{{USED_SERVICE_VERSION}}]"

apiomat:
  service:
    discovery:
      uses:
        HobbitService:
	      name: HobbitService
	      version: "[1.0.0]"