The BAMM CLI is a command line tool for the validation of Aspect models and the generation of artifacts, such as documentation or code, from Aspect models.

Download latest version: bamm-cli-2.1.0.jar

Running the BAMM CLI

The basic way to run the tool is as follows:

java -jar bamm-cli-2.1.0.jar -i AspectModel.ttl switch

where switch is one of the following:

Switch Description

--validate or -v

Validate the Aspect model

--generate-documentation or -html

Generate HTML documentation

--generate-dot-diagram or -dot

Generate diagram in Graphviz/DOT format

--generate-java-classes or -java

Generate Java domain classes (POJOs)

--generate-json-payload or -json

Generate sample JSON payload

--generate-json-schema or -schema

Generate JSON Schema

--generate-openapi-json or -oapi-json

Generate OpenAPI JSON specification for an Aspect Model

--generate-openapi-yaml or -oapi-yaml

Generate OpenAPI YAML specification for an Aspect Model

--generate-png-diagram or -png

Generate diagram in PNG format

--generate-static-java-classes or -static-java

Generate static meta classes

--generate-svg-diagram or -svg

Generate diagram in SVG format

--migrate or -m

Automatically migrate an Aspect model to the latest Meta Model version

--pretty-print or -p

Print an Aspect model nicely formatted

The following switches can be used in addition to the ones above to configure the generation:

Switch Description

--output-directory or -d

Set the directory where files are written, defaults to the current directory. This applies to all switches that generate files.

--package-name or -pn

Set the package name for generated Java files. This applies to -java and -static-java.

--disable-jackson-annotations or -dja

This option is to be used together with -java or -static-java and will lead to generated Java code that does not contain Jackson Annotations.

--use-semantic-api-version or -sv

This option is used together with -oapi-json or -oapi-yaml in order to use the complete semantic version of the Aspect Model as the version of the Aspect API.

--aspect-api-base-url or -base-url

This option is used together with -oapi-json or -oapi-yaml to provide the base URL for the Aspect API OpenAPI specification.

--include-aspect-query-api or -query-api

This option is used together with -oapi-json or -oapi-yaml to include the path for the Query Aspect API Endpoint in the OpenAPI specification.

--aspect-exclude-paging or -no-paging

This option is used to exclude the paging information in the OpenAPI specification. Paging is per default activated.

--aspect-time-based-paging or -atbp

This option is used to set the used paging strategy as time-based paging.

--aspect-offset-based-paging or -aobp

This option is used to set the used paging strategy as offset-based paging.

--aspect-cursor-based-paging or -acbp

This option is used to set the used paging strategy as cursor-based paging.

--aspect-resource-path or -arp

This option is used together with -oapi-json or -oapi-yaml to set the resource-path` for the Aspect API endpoints.

--aspect-parameter-file or -apf

This option is used together with -oapi-json or -oapi-yaml to set a file including the schema description for the resource. For JSON the description has to be in json, for YAML it has to be in YAML

Using the CLI to create a JSON OpenAPI Specification

Every specification is based on one Aspect, which needs a separately defined server URL where the given aspect will be. The URL will be defined as string with the -base-url command, i.e.: The default URL, using the above defined -base-url, would result in{tenantId}/<aspectName>;. By default the Aspect’s local name is used as path. The default path can be manipulated with the --aspect-resource-path switch. If the path is defined further, for example --aspect-resource-path "/resources/{resourceId}", the resulting URL would be:{tenantId}/resources/{resourceId}.

It will be required to specify the parameter, in case there is an additional parameter defined. This has to be in JSON or in YAML, depending on the kind of specification chosen. For example: With the option --aspect-resource-path "/resources/{resourceId}" the generator constructs the URL{tenantId}/resources/{resourceId} and then the --aspect-parameter-file defines the parameter resourceId in yaml:

  name: resourceId
  in: path
  description: An example resource Id.
  required: true
    type: string

The full command would result in:

java -jar bamm-cli-2.1.0.jar -i AspectModel.ttl -oapi-yaml -baseUrl ""
-arp "/resources/{resourceId}" -apf fileLocation

Understanding the models directory structure

An Aspect model file can contain an Aspect definition as well as other model elements that are defined in the same versioned namespace, as described in the Namespaces section of the specification. Additionally, it is possible to split one versioned namespace across multiple files, for example to define a Characteristic that is usable in multiple Aspects into its own file. In order for BAMM CLI to be able to resolve references to such externally defined model elements, the model files must be organized in a directory structure as follows:


where namespace corresponds to the hierarchical namespace that is part of the model element’s URN, e.g. com.mycompany.myproduct and version corresponds to the version of the namespace. The resulting directory structure then looks like the following:

models root
└── com.mycompany.myproduct
    ├── 1.0.0
    │   ├── MyAspect.ttl
    │   ├── MyEntity.ttl
    │   └── myProperty.ttl
    └── 1.1.0
        └── MyAspect.ttl

The name of the directory shown as models root above can be chosen freely. The BAMM CLI will resolve the file path relative to the input file by following the folder structure described above. Each of the files in the 1.0.0 directory should therefore have an empty prefix declaration such as @prefix : <urn:bamm:com.mycompany.myproduct:1.0.0#>.