microservice-helper

Small helper repo for microservice analyses based on jaxrs-cfx. References all packages needed to setup a server (and the Joana annotations package).

Idea

Encapsulate the microservice server stuff with a well-defined interface: We can than make assumptions on the server initialisation in the component based analysis :)

Therefore the analysis can (kind of) ignore the real bytecode of the body as the exact semantics is (kind of) known and the bytecode of the method can be removed. This leads to a far simpler program analysis (hopefully).

The EndpointMethod annotation marks methods that are known to just act as the interface of the underlying server and accept a service implementation, in every Object typed argument and runs it as a service. Their body can therefore by omitted.

Usage

Use it via maven

<dependency>
  <groupId>io.github.joana-team</groupId>
  <artifactId>microservice-helper</artifactId>
  <version>1.0.3</version>
</dependency>

For a minimal example of how this could be used to create a microservice with OpenAPI, look no further than the cat shop example.

How to publish a maven package

mvn clean   # Delete build contents                
mvn compile # Compile classes
mvn package # Build JAR
mvn verify  # Will sign/check GPG
mvn install # Install to local maven repo
mvn deploy  # Push to Sonatype->maven central
``