Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

OpenAPI Generator

Create SDKs from Emporix API specifications for seamless integration with the Commerce Engine using OpenApi Generator.

To facilitate customizations of Emporix Commerce Engine, so that it is tailored to your needs, you can use the OpenAPI generator The tool allows you to generate code out of the API reference specifications. You can create a Software Development Kit (SDK) based on the OpenAPI-generated code using Emporix services, which you can then integrate into your codebase to seamlessly build your platform with the Commerce Engine.

Prerequisites

Make sure you have the following tools installed:

  • maven - version 3.5.4_1 or higher

  • Java - version 17.0 or higher

Installing

Download the Maven project OpenAPI Generator and unpack it in a relevant destination.

Using OpenAPI Generator

  1. Get the OpenAPI specification (api.yml) for the Emporix service you want to generate a client for. See the List of API Services for the available services and their interactive API references.

  2. Copy that API reference yml file to the src/main/resources/apis directory.

  1. In the command-line tool, open apireference-client-generator and run

mvn clean compile

Result: This command generates the code out of API reference documentation in the target directory. You can see the generated classes under /target/generated-sources/openapi/src/.

Generated classes

Last updated

Was this helpful?