API-Sheriff

Status

Build & Quality

Performance Benchmarks

Micro Benchmarks

Integration Benchmarks

Understand Performance Metrics

Generated Documentation on github-pages

What is it?

A template project demonstrating a multi-module Maven structure with Quarkus integration and comprehensive benchmarking.

Table of Contents

• Status
• What is it?
• Maven Coordinates
• Additional Modules
  • Quarkus Integration
  • Performance Benchmarking
    • Micro-Benchmarks
    • Integration Benchmarks
• External Resources

Maven Coordinates

<dependency>
    <groupId>de.cuioss.sheriff.api</groupId>
    <artifactId>api-sheriff-library</artifactId>
</dependency>

Additional Modules

The project includes several additional modules that extend the core functionality:

Quarkus Integration

The Quarkus Extension provides seamless integration into Quarkus applications. It includes:

• CDI producers for easy dependency injection

• Configuration support via Quarkus properties

• Native image support for GraalVM compilation

<dependency>
    <groupId>de.cuioss.sheriff.api</groupId>
    <artifactId>api-sheriff-quarkus</artifactId>
</dependency>

Performance Benchmarking

The project includes two complementary benchmarking modules:

Micro-Benchmarks

The Benchmark Library provides in-memory performance measurements using JMH (Java Microbenchmark Harness).

Integration Benchmarks

The Quarkus Integration Benchmarks provides end-to-end performance testing using containerized environments.

Understand Performance Metrics

External Resources

• Generated Documentation on GitHub Pages