OpenAPI to GRPC

The concept is to create a GRPC API from a given OpenAPI, with all models generated.

Use case: TM720 Digital Identity API https://projects.tmforum.org/wiki/display/API/Open+API+Table

1. Use the TMF Open API specification for TMF720 Digital Identity
2. Use Quarkus GRPC and MongoDB
3. Generate the Protobuf Schema from the OpenAPI
4. Generate the Service and Proto Models from the Protobuf Schema
5. Utilize protobuf util JSONFormat to persist and retrieve the objects in MongoDB

Running the application in dev mode

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

./mvnw compile quarkus:dev

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:

./mvnw package

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

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

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

./mvnw package -Dquarkus.package.type=uber-jar

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

Creating a native executable

You can create a native executable using:

./mvnw package -Pnative

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

./mvnw package -Pnative -Dquarkus.native.container-build=true

You can then execute your native executable with: ./target/quarkus-grpc-1.0.0-SNAPSHOT-runner

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

Related Guides

Provided Code