Home Applications realworld-api-quarkus-iris

realworld-api-quarkus-iris

This application is not supported by InterSystems Corporation. Please be notified that you use it at your own risk.
0
0 reviews
0
Awards
144
Views
0
IPM installs
1
1
Details
Releases
Reviews
Issues
Articles  (2)
A simple case of a real-world API using Quarkus framework.

What's new in this version

Initial Release

RealWorld Example App

Quarkus Framework codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld spec and API.

This codebase was created to demonstrate a fully fledged fullstack application built with Quarkus
including CRUD operations, authentication, routing, pagination, and more.

We’ve gone to great lengths to adhere to the Quarkus community styleguides & best practices.

For more information on how to this works with other frontends/backends, head over to
the RealWorld repo.

Java CI with Maven

InterSystems IRIS Support

Original project: https://github.com/diegocamara/realworld-api-quarkus

  • Upgraded Quarkus
  • Added InterSystems IRIS as default datasource

Start IRIS with docker-compose, before run application

docker-compose up -d

How it works

This application basically uses Quarkus Framework with Java 11 with some other modules known to development community:

  • Hibernate 6
  • Jackson for JSON
  • InterSystems IRIS database
  • JPA Criteria
  • Auth0 java-jwt

Project structure:

application/            -> business orchestration layer
+-- web/                -> web layer models and resources
domain/                 -> core business implementation layer
+-- model/              -> core business entity models
+-- feature/            -> all features logic implementation
+-- validator/          -> model validation implementation 
+-- exception/          -> all business exceptions
infrastructure/         -> technical details layer
+-- configuration/      -> dependency injection configuration
+-- repository/         -> adapters for domain repositories
+-- provider/           -> adapters for domain providers
+-- web/                -> web layer infrastructure models and security

Getting started

Start local server

 ./mvnw compile quarkus:dev

The server should be running at http://localhost:8080

Running the application tests

./mvnw test 

Running postman collection tests

./collections/run-api-tests.sh

Building jar file

./mvnw package

Building native executable

GraalVM is necessary for building native executable, more information about setting up GraalVM can be found
in Quarkus guides
and database engine need to be changed.

./mvnw package -Pnative

Database changes can be made to the application.properties file.

# Database configuration
quarkus.datasource.db-kind=other
quarkus.datasource.jdbc.url=jdbc:IRIS://localhost:1972/REALWORLD
quarkus.datasource.jdbc.driver=com.intersystems.jdbc.IRISDriver
quarkus.datasource.username=_SYSTEM
quarkus.datasource.password=SYS
quarkus.hibernate-orm.dialect=io.github.yurimarx.hibernateirisdialect.InterSystemsIRISDialect

Help

Improvements are welcome, feel free to contribute.

Version
1.0.015 Aug, 2023
Category
Technology Example
Works with
InterSystems IRIS
First published
15 Aug, 2023