https://github.com/cuioss/api-sheriff

An API-Gateway focused on Security and a leightweight approach
https://github.com/cuioss/api-sheriff

Last synced: 9 months ago
JSON representation

An API-Gateway focused on Security and a leightweight approach

• Host: GitHub
• URL: https://github.com/cuioss/api-sheriff
• Owner: cuioss
• License: apache-2.0
• Created: 2025-08-08T18:24:34.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2025-08-08T19:46:37.000Z (10 months ago)
• Last Synced: 2025-08-08T21:27:52.031Z (10 months ago)
• Language: Java
• Size: 28.3 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
= API-Sheriff

:toc: macro

:toclevels: 3

:sectnumlevels: 1

[.discrete]

== Status

**Build & Quality**

image:https://github.com/cuioss/API-Sheriff/actions/workflows/maven.yml/badge.svg?branch=main[Java CI with Maven,link=https://github.com/cuioss/API-Sheriff/actions/workflows/maven.yml]

image:https://github.com/cuioss/API-Sheriff/actions/workflows/integration-tests.yml/badge.svg[Integration Tests,link=https://github.com/cuioss/API-Sheriff/actions/workflows/integration-tests.yml]

image:https://img.shields.io/github/last-commit/cuioss/API-Sheriff/main[Last Build,link=https://github.com/cuioss/API-Sheriff/commits/main]

image:http://img.shields.io/:license-apache-blue.svg[License,link=http://www.apache.org/licenses/LICENSE-2.0.html]

image:https://img.shields.io/maven-central/v/de.cuioss.sheriff.api/api-sheriff-parent.svg?label=Maven%20Central["Maven Central", link="https://central.sonatype.com/artifact/de.cuioss.sheriff.api/api-sheriff-parent"]

image:https://sonarcloud.io/api/project_badges/measure?project=cuioss_API-Sheriff&metric=alert_status[Quality Gate Status,link=https://sonarcloud.io/summary/new_code?id=cuioss_API-Sheriff]

image:https://sonarcloud.io/api/project_badges/measure?project=cuioss_API-Sheriff&metric=ncloc[Lines of Code,link=https://sonarcloud.io/summary/new_code?id=cuioss_API-Sheriff]

image:https://sonarcloud.io/api/project_badges/measure?project=cuioss_API-Sheriff&metric=coverage[Coverage,link=https://sonarcloud.io/summary/new_code?id=cuioss_API-Sheriff]

**Performance Benchmarks**

image:https://github.com/cuioss/API-Sheriff/actions/workflows/benchmark.yml/badge.svg[JMH Benchmarks,link=https://github.com/cuioss/API-Sheriff/actions/workflows/benchmark.yml]

image:https://img.shields.io/endpoint?url=https://cuioss.github.io/api-sheriff/benchmarks/badges/last-run-badge.json[Last Benchmark Run,link=https://cuioss.github.io/api-sheriff/benchmarks/]

*Micro Benchmarks*

image:https://img.shields.io/endpoint?url=https://cuioss.github.io/api-sheriff/benchmarks/badges/performance-badge.json[API Sheriff Performance Score,link=https://cuioss.github.io/api-sheriff/benchmarks/index-visualizer.html]

image:https://img.shields.io/endpoint?url=https://cuioss.github.io/api-sheriff/benchmarks/badges/trend-badge.json[Performance Trend,link=https://cuioss.github.io/api-sheriff/benchmarks/performance-trends.html]

*Integration Benchmarks*

image:https://img.shields.io/endpoint?url=https://cuioss.github.io/api-sheriff/benchmarks/badges/integration-performance-badge.json[Integration Performance,link=https://cuioss.github.io/api-sheriff/benchmarks/integration-index.html]

image:https://img.shields.io/endpoint?url=https://cuioss.github.io/api-sheriff/benchmarks/badges/integration-trend-badge.json[Integration Trend,link=https://cuioss.github.io/api-sheriff/benchmarks/integration-performance-trends.html]

xref:benchmarking/doc/performance-scoring.adoc[Understand Performance Metrics]

https://cuioss.github.io/api-sheriff/about.html[Generated Documentation on github-pages]

[.discrete]

== What is it?

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

toc::[]

== Maven Coordinates

[source,xml]

----

    de.cuioss.sheriff.api

    api-sheriff-library

----

== 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

[source,xml]

----

    de.cuioss.sheriff.api

    api-sheriff-quarkus

----

=== 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.

xref:benchmarking/doc/performance-scoring.adoc[Understand Performance Metrics]

== External Resources

* https://cuioss.github.io/api-sheriff/about.html[Generated Documentation on GitHub Pages]