The Backbase Open API Tools is a collection of tools created to work efficiently with OpenAPI

It currently consists of

• Create Diff Report between 2 OpenAPI versions of the same spec (Based on https://github.com/quen2404/openapi-diff)
• Decompose Transformer to remove Composed Schemas from OpenAPI specs to aid in code generators
• Case Transformer to view how your API looks like when going from Camel Case to Snake Case (transforms examples too)
• Code Generator based on openapi-generator.tech with optimized templates and fixes.
• Lint mojo based on Zalando Zally and Backbase API

BOAT is still under development and subject to change.

• Lint rule B014 doesn't throw a null exception when parsing a string array property in a schema.

• ISSUE: #776 add new lint rule B014 - to validate if examples contain all defined properties in the schema
• BOAT now supports multiple access control permissions within the tag x-BbAccessControls in the OpenAPI spec. It contains two parameters description which describes the relationship between the permissions and permissions which is an array of permissions with tags resource, function and privilege.
• Improve generated client Class Name
• Fix Jakarta native client generation options

• Angular 17

• Fixed Spring deprecations

• boat-spring
  • Fix Inconsistent @Component for RestTemplate

• Boat Engine
  • Added support for byte array examples
• Boat Scaffold
  • Removed tag import in order to allow BOAT objects to have the name 'tag'

• boat-maven-plugin
  • Issue 211: Fix typo in changelogRenderer parameter in DiffMojo.java (#652) @talbot

• boat-spring, boat-java
  • Issue 649: missing BigDecimalCustomSerializer.java (#650) @walaniam
• BOAT Android (#637) @charbelmkh

• boat-spring
  • Fix [Regression on putting valid annotation on FQCN,#619]
  • Fix [Broken pojo field validations, #633]
  • Fix Add @NotNull for required properties.
  • Fix initiation of required property that has additionalProperties (generated as Map) when using containerDefaultToNull=true
  • Fix createApiComponent option in springtemplate generator is ignored
  • Fix #635
  • Fix [List of Maps of Strings generated code does not compile. ,#647]

• BOAT Angular Generator
  • added @angular/common as peer dependency in the generated package.json files
  • replace usages of isListContainer with isArray in api.service template

• boat-spring
  • fix: incorrectly used enum param on collection items (see collectionDataTypeParam.mustache)

• boat-spring
  • added validation constraints on primitive collection items types in request params (see collectionDataTypeParam.mustache)
  • added validation constraints on primitive map value types (see mapDataType.mustache)

• boat-spring
  • Fix: generate validation constraints on primitive collection items types (updates in pojo.mustache and new collectionDataType.mustache)

• BoatJavaCodeGen, BoatSpringCodeGen
  • Fix: Always generate collection initializer when array is required in the schema (even if containerDefaultToNull=true)
  • Fix: validated pojo referenced class causes invalid code to be generated
  • Fix: boat-java pojo template to support useWithModifier to generate withSomething methods; fixes referencing 'common' classes generated using boat-spring templates.

• BoatJavaCodeGen, BoatSpringCodeGen
  • Fix: always generate collection initializer when array is required in the schema (even if containerDefaultToNull=true)

• Boat maven plugin
  • Fix: When using Multipart, generate with @RequestPart instead of @RequestParam

• Boat Maven plugin
  • Fix: containerDefaultToNull=true is not backward compatible

• Boat Spring generator
  • Fix: Serialization / deserialization issues of JsonSubTypes due to incorrect usage of JsonIgnoreProperties

• Boat maven plugin
  • Fix: Added 'containerDefaultToNull' default option to the MOJO generator

• Boat engine
  • Fix: Processing of a single string type example on media-type.

• Boat Angular generator
  • New format for Angular mocks, which are now export an array with responses.

• Boat Angular generator
  • Map the Set type to Array by default to avoid breaking changes vs clients generated with 0.16.x.

• Boat Angular generator
  • Remove leading comment from typescript files so that there are fewer differences between files when regenerating with a new spec version (info moved to README)
  • Remove licence field from package.json

• Boat Angular generator
  • Added artifact information to generated package.json

• General
  • Removed RAML Support
  • Removed custom JavaScript client
  • Update OpenAPI Tools to 6.2.1
• Boat Java Generator
  • Jakarta EE 9 compatibility
  • spring-mvc library is removed because it is not supported by OpenAPI Tools anymore
  • Use of Set for unique items is now enabled by default as OpenAPI Generator fixed their implementation

• Boat engine
  • Fix: Processing of a single string type example on media-type.
• Boat Angular generator
  • New format for Angular mocks, which are now export an array with responses.

• Boat Angular generator
  • @angular/common added as a peer dependency in the generated package.json files

• Boat Angular generator
  • Remove leading comment from typescript files so that there are fewer differences between files when regenerating with a new spec version (info moved to README)
  • Remove licence field from package.json

• Boat Angular generator
  • Set removeComments: false in generated tsconfig.json files to retain /*#__PURE__*/ annotation in compiled JS.

• Boat Angular generator
  • Remove types from generated mock providers due to a TypeScript which prevents /*#__PURE__*/ annotation from working

• Boat Angular generator
  • Use of /*#__PURE__*/ for createMocks function call in templates to enable tree-shaking

• Boat Angular generator
  • Use ^ instead of >= for devDependencies in the generated project, so project will be built using correct target version of ng-packagr & the Angular CLI
  • Declare some extra devDependencies at explicit versions to fix npm install issues in the generated project when using npm v8

• Boat Angular generator
  • Allow any format for spec versions.

• Boat Angular generator
  • Add ability to bake the spec version used in the package.json file.

• Maven Plugin
  • Do not treat spaces as delimiters in configuration properties which take a comma-separated list of values. Fixes an issue that prevented the use of tag names containing spaces in the apisToGenerate property.

• Boat Angular generator
  • Specify minimum Angular-related package versions when Angular v13 is used

• Boat Java generator
  • Java 17 compatibility update

• Boat Angular generator
  • Use >= for main peer dependency to improve forward compatibility

• Boat Scaffold
  • Makes sure to not autogenerate examples from schema if examples are already present

• Maven Plugin
  • Add example of use the additional properties like createApiComponent
• Boat Angular generator
  • Generate the ng-package.json file for use with the ng-package CLI

• Boat Lint
• Bumped version of Zally Linting Libraries that contain several vulnerability fixes

• Boat Angular generator
  • Enable partial Ivy compilation for libraries.

• Boat Scaffold
• A fix for mapping of Map for query params (in client code).

• Maven Plugin
  • Fixed handling of absolute file paths for linting OpenAPI specs
  • Changed boat-bay dateLibrary for upload spec .

• Maven Plugin
  • Made boat:radio goal properties w.r.t boat-bay server unique.

• Maven Plugin
  • Added new goal boat:radio; see the description in the plugin documentation.

• Boat Scaffold
  • References to /examples/foo now are also dereferenced

• Boat Scaffold
  • Makes sure to URLDecode paths while dereferencing examples

• Boat Scaffold
  • Resolve references to other path operations' examples

• Boat Marina
  • Removes flatObjects as they are no longer needed
  • response.message was wrongfully escaped, escaping in the docs template instead
  • We no longer need to generate model aliases in boat marina

• Boat Marina
  • Exports flatObjects as a model to prevent errors with references

• Maven Plugin
  • Added boat:ship mojo to automagically zip specs found in src/main/resources and attach it to the project reactor so mvn install or mvn deploy will also include a zip archive of the project with with api classifier
  • Changed boat:bundle includes parameter to an array of patterns to allow recursive patters to discover OpenAPIs
• Boat Scaffold
  • Fixed bug in typescript generator where only one of the overloaded function signatures per deprecated endpoint was marked as deprecated.

• Boat Marina
  • Added boat-markers directory in target to keep track of successful and unsuccessful actions on OpenAPI specs

• Boat Marina

  • Added a now BOAT Scaffold template called Marina, as that is where the models hang out. The Boat Marina template outputs a single JSON file that is used to offer a rich user interface built from the specs including search, page per operation and many more features!

• Maven Plugin

  • The boat:doc goal now recursively search OpenAPI specs in a directory to generate docs for each found spec.

• Maven Plugin
  • Added new goal boat:transform; see the description in the plugin documentation.

• Angular Generator
  • Added support for Angular version ranges in peer dependencies

• Angular Generator
  • Added support for Angular 11

• Angular Generator
  • Simplify Angular generator options by removing the unused ones (withInterfaces,providedInRoot)
  • fix Mock is not generated if Http status equals to 201 (SDK-2388)

• Lint
  • Added rules.
    • Check plurals on paths resource names.
    • Check prefix for paths should contain version.
  • Enabled rules.
    • Use Standard HTTP Status Codes.

• General
  • Improved code quality
  • Added more unit tests
  • Added more realistic example projects in boat-maven-plugin
  • Added help:describe support for boat-maven-plugin
  • Fixed building in Windows
• Boat Docs
  • Render response examples from response instead of schema object
• Lint
  • Added additional rules.
    • Check x-icon value in the info block.
    • Check info block description.
    • Check tags allowed.
    • Check info block title.
    • Check prefix for paths. i.e. "client-api", "service-api", "integration-api"
  • Ignore Zalando Ruleset by default in boat-maven-plugin

• Java Templates

  • Correct the import and use of @Qualifier in ApiClient template
  • Only change base type when date useSetForUniqueNames is set true

• Boat Docs

  • Handle examples for MediaTypes without Schemas (such as text/csv)

• Angular Generator
  • Apply the correct return type when multiple responses are present
  • Generate mocks for examples defined in dereferenced schemas

• Java Generator - boat-spring library
  • Fixed reactive spring templates
  • Avoid importing HttpServletResponse when using reactive
• Angular Generator
  • Handle empty bodies properly in Mock generation
  • Update foundation-ang to latest version

• Maven Plugin

  • Added removeExtensions mojo parameter to boat:bundle to filter out the given vendor extensions from bundle.
  • Added includes mojo parameter to boat:bundle as a glob pattern selecting the specification files (defaults to *.yaml).
  • Added apisToGenerate mojo parameter to boat:generate
  • Set the default of httpUserAgent to ${project.artifactId}-${project.version}.

• Java Generator - resttemplate library

  • Added useWithModifiers option to use the with prefix for POJO modifiers (defaults to false).
  • added useSetForUniqueItems to map arrays containing uniqueItems to Set (defaults to false).
  • Added useClassLevelBeanValidation option (defaults to false).
  • Added useJacksonConversion to use Jackson for parameters conversion instead of toString (defaults to false).
  • Added restTemplateBeanName to qualify the autowired RestTemplate bean.

• Angular Generator

  • Added an Angular client generator for version 10 and up. The generator template is inherited from the standard one at openapi-generator.tech, with the addition of mock responses and a several fixes, among which:
    • Handling of reserved typescript words
    • Added support for Typescript and Javascript for escaping of strings in generators
    • Escaping of model properties when not using camelCase
    • Support for multiple MediaTypes
  • To enable mocks generation, set the withMocks option to true

• Maven Plugin
  • boat:lint mojo will generate an HTML report based on API Guidelines
  • boat:docs mojo will generate HTML documentation from OpenAPI showing multiple examples and requests as well as Custom Annotations
• General Bug Fixes
• Linting Rule Engine extended with reserved word linting
• NOTE: The lint rules are still in development. The documentation is still in the works.

• Maven Plugin
  • Added version parameter to bundle goal.
  • Added bundleSpecs parameter to generate goal to automatically bundle specs into single file
• Modernised BOAT Terminal
• Improved BOAT:Docs Templates
• Properly dereference examples

• Improved styling HTML docs
• preview BOAT:QUAY linting mojo for linting OpenAPI specs.
• Avoid circular references when derefenencing OpenAPI specs

• Render multiple requests and examples in boat-docs

• Created HTML templates for boat-docs

• Pretty Print JSON Examples

• Added boat:doc mojo for generating beautiful HTML2 docs

• • Spring Generator*
  • Restored HttpServletRequest parameter (regression).

• Added boat:yard to create static website based on a collection of specs

• simple fix to check for null value in openApi.getComponents().getSchemas()
• ability to resolve references like #/components/schemas/myObject/items or #/components/schemas/myObject/properties/embeddedObject
• simple fix to avoid npe in StaticHtml2Generation escaping response message.

• Add DereferenceComponentsPropertiesTransformer (that does a bit extra)
• Fix recursive referencing in UnAliasTransformer

• Added bundle skip
• Changed numbering scheme

• Maven Plugin

  • Added bundle.skip parameter to bundle goal (defaults to false).

• HTML2 Generator

  • Removes examples
  • Adds title of API to the left navigation
  • Removes unnecessary spaces in the docs
  • Fixes item focus on left navigation
  • Updates Json Schema Ref Parser library
  • Updates Json schema view library
  • Adds support for allOf with Json schema merge all of https://github.com/mokkabonna/json-schema-merge-allof
  • Fixes header x- params being escaped. eg X-Total-Count to XMinusTotalMunisCount
  • Fixes markdown in description not being escaped and breaking javascript.
  • Fixes missing references to extended simple types (set unAlias option to true).
  • Fixes missing references because confusion over whether to reference name or classname.
  • Moved the code generation into a separate module to be used by other BOAT components.
  • Cleaning up dependencies
  • Added boat:bundle mojo to bundle fragments into a single spec.
  • boat:bundle unaliases the spec.

• Spring Generator

  • Added useWithModifiers to use the with prefix for POJO modifiers (defaults to false; for compatibility with the old RAML generator must be set to true).
  • Fixed x-abstract extension (not generated)
  • Reset the defaults of the options added in 0.2.7 to avoid breaking changes.
    • useLombokAnnotations: false
    • openApiNullable: true
    • useSetForUniqueItems: false

• Spring Generator

  • added in-container validation, e.g. List<@Size(max = 36) String> (see JSR-380 - Container element constraints).
  • added vendor extensions: x-abstract, x-implements.
  • added useLombokAnnotations option (defaults to true)
  • added openApiNullable option (taken from 5.0, breaking change, defaults to false, set to true if not ready).
  • added useSetForUniqueItems to map arrays with uniqueItems to Set instead of List (breaking change, defaults to true, set to false if not ready).
  • added additionalDependencies to be used in spring-boot/pom.mustache template.
  • formatted method parameters.

• Maven Plugin

  • added addTestCompileSourceRoot which adds the output directory to the project as a test source root.
  • added apiNameSuffix to customise the name of the API interface.
  • corrected generatorName property to point to openapi.generator.maven.plugin.generatorName.
  • fixed the code generated for properties of type Map in model.
  • refactored GenerateMojo so mvn boat:generate -Dcodegen.configHelp -Dopenapi.generator.maven.plugin.generatorName=spring works correctly.
  • test the generated code in the integration test phase

• Ensure RAML traits that are converted to OAS extensions are all using lower case.

• Fixed a bug how duplicate names are generated if RAML source has duplicate names for references. The parent resource name is now prepended to the schema name without removing the last character of the parent resource name
• Fixed a bug when in RAML resources were inline references instead of global type references for Request Bodies causing Response Schemas being referenced as Request Bodies

• Changed how operationIds are generated. The previous implementation ended up generating very long and confusing names. The improved generator greatly improves the names of operationId when converting from RAML to OAS3
• Default version of OpenAPI is now 3.0.3
• Generated STUBS and Clients must be refactored to use the new names! It should not affect the names of Schemas converted from RAML.

• Use RAML Display Name as Summary on Http Operations when converting to OAS3
• Also include integration-spec and artifacts ending on specs as default for conversion using export-dep
• Fix HTML2 Titles

• Fixed enum conversion. Empty enums are now set to null again when converting from raml to OpenAPI
• Added more robust code gen mojos

• Improved Open API Diff
• Sonar Fixes

• Created new Code Generation Mojos with opinionated settings for ** Java Client with Spring WebClient (Reactive) ** Java Server Stubs for WebFlux (Reactive) ** Java Client with Spring Rest Template (Non Reactive) ** Java Server Stubs for Spring Rest Controller (Non Reactive) ** Improved Java Client API's to better cope with reserved words
• Export Dependencies will now traverse through the artifact to find all raml specs
• Improved RAML 2 Open API conversion
• Upgraded OpenAPI Diff library to more current version
• Mojo's can now break the build by setting continueOnError to false

• Improved how services are named after base url conversion was introduced.

• Reversed normalization of schema names as that causes stack overflow errors.
• Fixed Base URL Conversion from RAML to OpenAPI
• Specify schema type when adding additional properties in Maven plugin using additionalPropertiesType configuration option

• Added configurable flag to add HttpServletRequest parameters to codegen'd server stubs.
• Extract inline examples from the obtained OpenAPI spec and put them under '/examples/' as json files.
• Changed the normalization of Schema Names to ensure existing casing is not lost

• Added documentation on boat-maven-plugin
• Upgraded YAML Libraries to improve output of YAML files
• Use standardized swagger YAML output
• Added Bean Validator in Code Generator
• Changed Open API Loader to correctly resolve references from reading input location instead of string

• Upgraded openapi-generator to 4.3.0
• Fixed java doc in the Java templates to allow usage in Java 11 projects
• Rename variable name accept to acceptMediaType in Java templates to allow OpenAPI Specs with parameters called accept

• Fixed template for HTML2 generator
• Include conversion of api.raml files found in dependencies

• Added Code Generator Mojo from on openapi-generator.tech with custom templates for Java, JavaSpring and HTML2
• Renamed export to export-dep mojo for converting RAML specs to oas from dependencies
• Added export mojo for converting RAML specs from input file
• Added Normaliser transformer for transforming examples names to be used in Java code generation as example names cannot have special characters.
• Improve Title and Descriptions of converted RAML specs
• Always wrap examples in example object
• Many code improvements to be not ashamed of Sonar Reports.

mvn install

The following command will generate index.html file in the specified output folder that contains API endpoints description.

mvn boat:generate@generate-docs

Configuration

<build>
  <plugins>
    <plugin>
      <groupId>com.backbase.oss</groupId>
      <artifactId>boat-maven-plugin</artifactId>
      <version>${boat-maven-plugin.version}</version>
      <executions>
        <execution>
          <id>generate-api-code</id>
          <goals>
            <goal>generate</goal>
          </goals>
          <phase>generate-sources</phase>
          <configuration>
            <inputSpec>${project.basedir}/src/main/resources/api.yaml</inputSpec>
            <output>${project.build.directory}/generated-sources/api</output>
            <generatorName>spring</generatorName>
            [...]
            <configOptions>
              <library>spring-boot</library>
              <apiPackage>com.example.my.service.api.interfaces</apiPackage>
              <modelPackage>com.example.my.service.models</modelPackage>
              <hideGenerationTimestamp>true</hideGenerationTimestamp>
              <dateLibrary>java8</dateLibrary>
              <interfaceOnly>true</interfaceOnly>
              <skipDefaultInterface>true</skipDefaultInterface>
              <useBeanValidation>true</useBeanValidation>
              <useTags>true</useTags>
              <java8>true</java8>
              <useOptional>false</useOptional>
              [...]
            </configOptions>
          </configuration>
        </execution>
      </executions>
    </plugin>
 </plugins>
</build>

A comprehensive list of the Configuration options can be found below.

For the spring generator, the additional configuration options are: