Java REST Client library

Welcome to the Java REST Client Library! This library provides a convenient way to interact with RESTful APIs in Java applications. Whether you're building a web service client, integrating with third-party APIs, or developing a microservice architecture, this library aims to simplify the process of making HTTP requests and handling responses.

Table of Contents

• Minimum Requirements
• Dependencies
• Maven Dependency
• Documentation
• Contributing
• License
• Contact
• Donations

Minimum Requirements

Java 17 or above.

Dependencies

• com.fasterxml.jackson.core:jackson-databind:jar:2.18.0
• com.fasterxml.jackson.dataformat:jackson-dataformat-xml:2.18.0
• org.junit.jupiter:junit-jupiter:jar:5.11.3
• org.junit.platform:junit-platform-suite-engine:jar:1.11.3
• org.apache.logging.log4j:log4j-api:2.24.2
• org.apache.logging.log4j:log4j-core:2.24.2
• org.apache.logging.log4j:log4j-slf4j2-impl:2.24.2

Maven Dependency

The library is available on GitHub Packages, and on Maven Central starting from version 0.3.3. To include this library in your Maven project, add the following dependency to your pom.xml:

<dependency>
  <groupId>io.github.mbenincasa</groupId>
  <artifactId>java-rest-client</artifactId>
  <version>0.3.4</version>
</dependency>

If you want to use GitHub Packages, you need to add the GitHub Packages repository to your pom.xml or settings.xml and authenticate using your GitHub token.

Add GitHub Packages Repository

In your pom.xml, add the following repository configuration:

<repositories>
    <repository>
        <id>github</id>
        <url>https://maven.pkg.github.com/MBenincasa/java-rest-client</url>
    </repository>
</repositories>

Add Authentication for GitHub Packages

In your settings.xml (located in the .m2 directory), add the following server configuration to authenticate with GitHub Packages:

<servers>
    <server>
        <id>github</id>
        <username>your-github-username</username>
        <password>your-github-token</password>
    </server>
</servers>

Replace your-github-username with your GitHub username and your-github-token with a GitHub Personal Access Token (PAT) that has the necessary permissions.

Documentation

You can find the documentation for each release in the docs folder

Contributing

We welcome contributions from the community to improve this library. If you encounter any bugs, have feature requests, or want to contribute code, please open an issue or submit a pull request on GitHub.

License

Distributed under the GNU General Public License v3.0. See LICENSE for more information.

Contact

Mirko Benincasa - [email protected]

Donations

Another way to support and contribute to the project is by sending a donation. The project will always be free and open source.
Click here to make a donation on PayPal