Skip to content

external-item-search

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

external-item-search

README.md

External Item Search Plugin

Plugin - External Item Search

This service enables searching for items outside the OQM system, in order to get their data into it.

An aggregation service to amalgamate item data from multiple sources into a single format for use in OQM.

Caches results from upstream API's to reduce usage where unnecessary.

Quarkus info

This project uses Quarkus, the Supersonic Subatomic Java Framework.

If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .

Running the application in dev mode

You can run your application in dev mode that enables live coding using:

./gradlew quarkusDev

NOTE: Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.

Packaging and running the application

The application can be packaged using:

./gradlew build

It produces the quarkus-run.jar file in the build/quarkus-app/ directory. Be aware that it’s not an über-jar as the dependencies are copied into the build/quarkus-app/lib/ directory.

The application is now runnable using java -jar build/quarkus-app/quarkus-run.jar.

If you want to build an über-jar, execute the following command:

./gradlew build -Dquarkus.package.jar.type=uber-jar

The application, packaged as an über-jar, is now runnable using java -jar build/*-runner.jar.

Creating a native executable

You can create a native executable using:

./gradlew build -Dquarkus.native.enabled=true

Or, if you don't have GraalVM installed, you can run the native executable build in a container using:

./gradlew build -Dquarkus.native.enabled=true -Dquarkus.native.container-build=true

You can then execute your native executable with: ./build/oqm-plugin-product_search-1.0.0-SNAPSHOT-runner

If you want to learn more about building native executables, please consult https://quarkus.io/guides/gradle-tooling.

Related Guides

  • REST (guide): A Jakarta REST implementation utilizing build time processing and Vert.x. This extension is not compatible with the quarkus-resteasy extension, or any of the extensions that depend on it.
  • REST Client (guide): Call REST services
  • SmallRye OpenAPI (guide): Document your REST APIs with OpenAPI - comes with Swagger UI
  • REST Jackson (guide): Jackson serialization support for Quarkus REST. This extension is not compatible with the quarkus-resteasy extension, or any of the extensions that depend on it
  • OpenTelemetry (guide): Use OpenTelemetry to trace services
  • YAML Configuration (guide): Use YAML to configure your Quarkus application
  • SmallRye JWT (guide): Secure your applications with JSON Web Token
  • Micrometer metrics (guide): Instrument the runtime and your application with dimensional metrics using Micrometer.

Provided Code

YAML Config

Configure your application with YAML

Related guide section...

The Quarkus application configuration is located in src/main/resources/application.yml.

REST Client

Invoke different services through REST with JSON

Related guide section...

REST

Easily start your REST Web Services

Related guide section...