rest

Eco Schema Catalog REST

Eco Schema Catalog REST is a Spring Boot web application that exposes RESTful interface for interaction of third-party services and applications with the Schema Catalog. Also, Eco Schema Catalog REST requires deployment of Elasticsearch for searching existing schemas.

Minimum configuration file

application.properties

eco.schemacatalog.store.schemaRegistryUrl=http://schema-registry:8081
eco.schemacatalog.store.kafka.bootstrapServers=kafka:9092
spring.elasticsearch.rest.uris=localhost:9200

or application.yml

eco:
  schemacatalog:
    store:
      schemaRegistryUrl: http://schema-registry:8081
      kafka:
        bootstrapServers: kafka:9092
spring:
  elasticsearch:
    rest:
      uris: localhost:9200

Running Eco Schema Catalog REST

You can run Eco Schema Catalog:

• As a standalone service

• In Docker

Running as standalone

The prerequisites include:

• Java 17+
• Confluent Platform (Kafka) 7.4
• Schema Registry 7.4
• Elasticsearch 7.9.x

The infrastructure example could be found in docker-compose.yml, which also could be used for launching Manual integration tests.

Run the following command sequence:

git clone [email protected]:epam/eco-schema-catalog.git
cd /eco-schema-catalog/rest
mvn clean package
java -jar ./target/schema-catalog-rest-<version>.jar --spring.config.location=file://<path-to-config-file>

Running in docker

The prerequisite includes Docker.

To build the image, run the following command sequence:

git clone [email protected]:epam/eco-schema-catalog.git
cd /eco-schema-catalog/rest
docker build -f ./Dockerfile -t epam/eco-schema-catalog-rest:latest ./../

Run the container:

docker run --name eco-schema-catalog-rest \
 --rm \
 -p 8082:8082 \
 -v <path-to-config-file>:/app/config/application.properties \
 epam/eco-schema-catalog-rest:latest

or using environment variables:

docker run --name eco-schema-catalog-rest \
 --rm \
 -p 8085:8085 \
 -e SERVER_PORT=8085 \
 -e SCHEMA_REGISTRY_URL=http://schema-registry \
 -e KAFKA_SERVERS_URL=kafka:9092 \
 -e BOOTSTRAP_TIMEOUT_MS=60000 \
 epam/eco-schema-catalog-rest:latest

or using inline JSON configuration:

docker run --name eco-schema-catalog-rest \
 --rm \
 -p 8082:8082 \
 -e SPRING_APPLICATION_JSON='{"eco":{"schemacatalog":{"store":{"schemaRegistryUrl":"http://schema-registry"}}}}' \
 epam/eco-schema-catalog-rest:latest

To open Schema Catalog REST API (swagger), go to http://localhost:8082/swagger-ui.html#

Note:

To reference files from the config file, it is possible to mount them with the -v option.
To tune JVM, use -e 'JAVA_OPTS=<some JVM options>'. For example:

docker run --name eco-schema-catalog-rest \
 --rm \
 -p 8082:8082 \
 -v <path-to-config-file>:/app/config/application.properties \
 -v <host-path-to-file-referenced-from-config>:<docker-path-to-file-referenced-from-config> \
 -m 3g \
 -e 'JAVA_OPTS=-Xms1g -Xmx1g' \
 epam/eco-schema-catalog-rest:latest

Dockerhub repo

https://hub.docker.com/r/epam/eco-schema-catalog-rest/tags

Configuration properties

In general, the application is built on Spring Boot 2.4.x and accepts all standard Spring Web, Spring Actuator, String Data Elasticsearch, Spring Security configuration options. See Spring Documentation.

Name	Environment Variable	Description	Default
sever.port	SERVER_PORT	Server HTTP port.	8082
eco.schemacatalog.store.schemaRegistryUrl	SCHEMA_REGISTRY_URL	URL to the Schema Registry REST API.	http://localhost:8081
eco.schemacatalog.store.kafka.bootstrapServers	KAFKA_SERVERS_URL	A comma-separated list of Kafka brokers used by the Schema Registry to store schemas.	localhost:9092
eco.schemacatalog.store.kafka.bootstrapTimeoutInMs	BOOTSTRAP_TIMEOUT_MS	Max duration in milliseconds for bootstrapping data from the Schema Registry storage. If the timeout is too small, you may observe stale data for some time (it gets consistent eventually) after the service is started.	60000
eco.schemacatalog.store.kafka.clientConfig[property]		Common Kafka client properties, used to connect to the Schema Registry schema storage (topic).
n/a	SPRING_APPLICATION_JSON	Flexible way to provide a set of configuration properties using inline JSON. For example, eco.schemacatalog.store.schemaRegistryUrl can be set as {"eco":{"schemacatalog":{"store":{"schemaRegistryUrl":"http://schema-registry"}}}}

License

Eco Schema Catalog REST is licensed under the Apache License, Version 2.0