zswag-java

Access & serve zserio services via REST/OpenAPI using Java with Spring Boot technology stack.

Prerequisites

1. JDK 17+
2. Maven 3.6
   
   

Known issues

The infrastructure to build native images (executables as well as corresponding Docker images) is present but the built modules do not work at the moment.

Usage

Build zserio calculator example (including OpenAPI file generation)

Java

mvn install

or run script

build-java.sh

Docker images using Java applications

mvn -Pdocker-java spring-boot:build-image

or run script

build-docker-java.sh

Native image using GraalVM

mvn -Pnative verify

with GraalVM used as default JDK and native plugin installed

or run script

build-native.sh

with environment variable $GRAALVM_HOME pointing to GraalVM directory and native plugin installed

Docker images using native image created with GraalVM

mvn -Pdocker-native spring-boot:build-image

or run script

build-docker-native.sh

Generated OpenAPI file during builds

.../zswag-java/server/generated-openapi/openapi.yaml

Generated OpenAPI client sources during builds

.../zswag-java/openapi-client/generated-client

Start REST server

Java (Spring Boot) application

java -jar server/targetJava/server-0.0.1-SNAPSHOT-boot.jar
# press Ctrl+C to quit the server

Docker image using Java (Spring Boot) application

Example using docker compose:

version: '3'

services:
  server:
    image: "zswag.java/server:0.0.1-SNAPSHOT"
    environment:
      - JAVA_OPTS=-Dspring.profiles.active="default"
    volumes:
      - /tmp:/tmp
      - /mnt:/mnt:ro
      - ./log-server:/logs
    ports:
      - "5000:5000"
    network_mode: bridge
    restart: always

Create Docker container and start it:

docker-compose up -d

Start the client console example

Java (Spring Boot) application

java -Dspring.profiles.active="default" -jar client/targetJava/client-0.0.1-SNAPSHOT-boot.jar

Docker image using Java (Spring Boot) application

Addition to docker compose example above:

...
  client:
    image: "zswag.java/client:0.0.1-SNAPSHOT"
    depends_on:
      - "server"
    environment:
      - JAVA_OPTS=-Dspring.profiles.active="default" -Dspring.config.additional-location="file:/config/"
    volumes:
      - /tmp:/tmp
      - /mnt:/mnt:ro
      - <local file path for external config file>:/config
      - ./log-client:/logs
    network_mode: bridge

In the local config file named application.yml you have to override "localhost" with the concrete machine ip address, e.g.

feign:
    url: 192.168.168.1:5000

Start the OpenApi client console example

Java (Spring Boot) application

java -Dspring.profiles.active="default" -jar openapi-client/targetJava/openapi-client-0.0.1-SNAPSHOT-boot.jar

Docker image using Java (Spring Boot) application

Addition to docker compose example above:

...
  openapi-client:
    image: "zswag.java/openapi-client:0.0.1-SNAPSHOT"
    depends_on:
      - "server"
    environment:
      - JAVA_OPTS=-Dspring.profiles.active="default" -Dspring.config.additional-location="file:/config/"
    volumes:
      - /tmp:/tmp
      - /mnt:/mnt:ro
      - <local file path for external config file>:/config
      - ./log-openapi-client:/logs
    network_mode: bridge

In the local config file named application.yml you have to override "localhost" with the concrete machine ip address, e.g.

feign:
    url: 192.168.168.1:5000

URL for OpenAPI Swagger UI

http://localhost:5000/swagger-ui

URL for OpenAPI docs (JSON format)

http://localhost:5000/api

Download URL for OpenAPI docs in YAML format

http://localhost:5000/api.yaml