RESTEasy

RESTEasy Netty is a RESTEasy project aimed to provide integration with Netty.

Documentation

To read the documentation you can read it online.

Maven Dependency Usage

To add the dependencies in Maven you can simply add the BOM.

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>dev.resteasy.netty</groupId>
            <artifactId>resteasy-netty-bom</artifactId>
            <version>${version.dev.resteasy.netty}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

Then you can use either the embedded server or client dependencies.

<dependencies>
    <dependency>
        <groupId>dev.resteasy.netty</groupId>
        <artifactId>resteasy-reactor-netty-client</artifactId>
    </dependency>

    <dependency>
        <groupId>dev.resteasy.netty</groupId>
        <artifactId>resteasy-netty-embedded-server</artifactId>
    </dependency>

    <dependency>
        <groupId>dev.resteasy.netty</groupId>
        <artifactId>resteasy-netty-embedded-server-cdi</artifactId>
    </dependency>
</dependencies>

Issues

Issues are kept in GitHub Issues.

Build

Currently, RESTEasy Netty requires JDK 17+ to compile, but compiles to Java 11 bytecode.

If you want to build the project without running the tests, you need to pull down a clone of the RESTEasy repository and run:

$ mvn clean install

Contribute

You are most welcome to contribute to RESTEasy!

Read the Contribution guidelines

Releasing

Releasing the project requires permission to deploy to Maven Central see Maven Central Release Requirements. Once everything is setup, you simply need to run the ./release.sh script. There are two required parameters:

1. -r or --release which is the version you want to release

2. -d or --development which is the next development version.

By default the release version cannot contain SNAPSHOT and the development version, must container SNAPSHOT.

Example Command

./release -r 1.0.0.Final -d 1.0.1.Final-SNAPSHOT

Supported Arguments

Argument	Requires Value	Description
-d, --development	Yes	The next version for the development cycle.
-f, --force	No	Forces to allow a SNAPSHOT suffix in release version and not require one for the development version.
-h, --help	No	Displays this help
-r, --release	Yes	The version to be released. Also used for the tag.
--dry-run	No	Executes the release in as a dry-run. Nothing will be updated or pushed.
-v, --verbose	No	Prints verbose output.

Any additional arguments are considered arguments for the Maven command.