Skip to content
This repository has been archived by the owner on Jan 3, 2024. It is now read-only.
/ eo-rs Public archive
generated from l3r8yJ/elegant

REST Responses in the EO fashion

License

Notifications You must be signed in to change notification settings

eo-cqrs/eo-rs

Repository files navigation

This repository is archived, it's successor: https://github.com/eo-cqrs/eokson

logo

Managed By Self XDSD

EO principles respected here DevOps By Rultor.com We recommend IntelliJ IDEA

maven maven central codecov

Hits-of-Code Lines-of-Code PDD status License

Project architect: @h1alexbel

REST Responses in the EO fashion.

Motivation. We are not happy creating classes like UserDto or ErrorDto each time we need work with REST responses. We're suggesting classes wrappers out of the box in clear, maintainable way.

Principles. These are the design principles behind eo-rs.

How to use. All you need is this (get the latest version here):

Maven:

<dependency>
  <groupId>io.github.eo-cqrs</groupId>
  <artifactId>eo-rs</artifactId>
</dependency>

Gradle:

dependencies {
    compile 'io.github.eo-cqrs:eo-rs:<version>'
}

Example

JsonError usage:

final JsonError json = new JsonError(
  new RsError.WithCode(
    "user not found",
    404
  )
);
final String content = json.content();

How to Contribute

Fork repository, make changes, send us a pull request. We will review your changes and apply them to the master branch shortly, provided they don't violate our quality standards. To avoid frustration, before sending us your pull request please run full Maven build:

$ mvn clean install

You will need Maven 3.8.7+ and Java 17+.

Our rultor image for CI/CD.