Custom Commerce Adapter Developer Manual / Version 2101
Table Of ContentsCoreMedia provides a dedicated mock adapter service implementation for customers and partners as a GitHub repository. It is meant as an example of how to implement a custom adapter service and provides a fully functioning Spring Boot service. The service can be build via Maven and runs either as a plain Spring Boot app or inside a Docker container.
In case the used technologies are applicable, CoreMedia recommends to use this project as a starter for building a custom adapter service.
Structure
The workspace can be found at https://github.com/coremedia-contributions/commerce-adapter-mock and includes a set of modules.
To get started developing a custom adapter service the following modules are needed.
adapter-mock-libThis module holds a sample implementation of a custom adapter service which is used by the Spring Boot app from theadapter-mock-appmodule.The repository implementations in this module should be adapted and serves as starting point for developing a custom commerce adapter.
adapter-mock-appThis module holds the ready to run Spring Boot app for the Mock Commerce adapter. The implementation sources are separated in theadapter-mock-libmodule.
The following modules contain convenience configuration, tooling and sample code for extending the commerce API by custom gRPC services.
adapter-mockThis module holds the Docker setup. Using the dockerfile-maven-plugin it can be used to build a Docker image for the mock adapter service.adapter-mock-customThis module includes service customization samples for the mock adapter service. It is referenced as dependency in thepom.xmlfile of theadapter-mock-app.adapter-mock-custom-grpcThis module holds a custom gRPC API definition which is then used by the services in theadapter-mock-custommoduleworkspace-configThis directory holds additional workspace configuration like the IntelliJ IDEA run configuration for the Spring Boot app.
Using the Commerce Adapter Mock
The CoreMedia Commerce Adapter Mock is not only a sample, showing how to implement a custom commerce adapter, but can also be used as a starter project.
If you decide to use the project as a starter, just checkout the latest revision from GitHub and rename and reorganize the modules and repositories as it suits your project.
The entry point for developing a custom commerce adapter is the adapter-mock-lib module.
It contains the repositories package, holding repository implementations for a broad
feature set, including the mandatory implementations for CatalogRepository,
CategoryRepository
and ProductRepository.
Beside the repositories package you will find some more packages, containing samples for retrieving data,
configuration or dealing with preview tokens. These packages are not needed for setting up a custom adapter service.
Note
To get a better idea of how to develop an adapter service you can also have a look at the CoreMedia adapter services for Salesforce, SAP Commerce or HCL Commerce.
Useful features like caching, using the CoreMedia Cache or Monitoring with services like Micrometer should be considered crucial for your custom commerce adapter as well.
The latest version of the sources can be found
here.
Usages of the CoreMedia Cache can be found in the com.coremedia.commerce.adapter.sfcc.cache package.
