jwcp-errors

Errors for http apis

License	Apache License, Version 2.0
GroupId	io.github.cdimascio
ArtifactId	jwcp-errors
Last Version	0.4.1
Release Date	Nov 4, 2018
Type	jar
Description	jwcp-errors Errors for http apis
Project URL	https://github.com/cdimascio/jwcp-errors
Project Organization	Carmine DiMascio OSS
Source Code Management	https://github.com/cdimascio/jwcp-errors

Download jwcp-errors

Filename	Size
jwcp-errors-0.4.1.pom
jwcp-errors-0.4.1.jar	9 KB
jwcp-errors-0.4.1-sources.jar	6 KB
jwcp-errors-0.4.1-javadoc.jar	40 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.github.cdimascio/jwcp-errors/ -->
<dependency>
    <groupId>io.github.cdimascio</groupId>
    <artifactId>jwcp-errors</artifactId>
    <version>0.4.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.github.cdimascio/jwcp-errors/
implementation 'io.github.cdimascio:jwcp-errors:0.4.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.github.cdimascio/jwcp-errors/
implementation ("io.github.cdimascio:jwcp-errors:0.4.1")

Apache Buildr

'io.github.cdimascio:jwcp-errors:jar:0.4.1'

Apache Ivy

<dependency org="io.github.cdimascio" name="jwcp-errors" rev="0.4.1">
  <artifact name="jwcp-errors" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.github.cdimascio', module='jwcp-errors', version='0.4.1')
)

Scala SBT

libraryDependencies += "io.github.cdimascio" % "jwcp-errors" % "0.4.1"

Leiningen

[io.github.cdimascio/jwcp-errors "0.4.1"]

Dependencies

compile (1)

Group / Artifact	Type	Version
com.fasterxml.jackson.core : jackson-annotations	jar	2.9.7

test (3)

Group / Artifact	Type	Version
org.junit.jupiter : junit-jupiter-api	jar	5.3.1
org.junit.jupiter : junit-jupiter-params	jar	5.3.1
org.junit.jupiter : junit-jupiter-engine	jar	5.3.1

Project Modules

There are no modules declared in this project.

japi-errors

Customizable errors for RESTful and HTTP services.

Out of the box, japi-errors provides two error formats or enables you to provide your own.

All 'out of the box' errors are Jackson ready and can be serialized as JSON, XML, and YAML. If you'd like to use GSON or something else, create a custom error creator.

Install

Gradle

compile 'io.github.cdimascio:japi-errors:1.3.1'

Maven

<dependency>
  <groupId>io.github.cdimascio</groupId>
  <artifactId>japi-errors</artifactId>
  <version>1.3.1</version>
</dependency>

Usage

Import error methods

import static io.github.cdimascio.japierrors.ApiError.badRequest;
// ...

Throw any HTTP error and optionally pass an exception or custom message.

throw notFound();
throw badRequest("id required.");
throw internalServerError(exception);
// ...

Assign

ApiError error = unauthorized();

See examples with Spring MVC

Configure

japi-errors supports two error formats "out of the box". They are enabled as follows:

ApiError.creator(ApiErrorCreators.BASIC); // The default
ApiError.creator(ApiErrorCreators.WCP);

Basic (default)

{
  "code": 400,
  "error": "id required."
}

WCP

{
  "trace": "1f96a430-dfd8-11e8-9f32-f2801f1b9fd1",
  "errors": [{
    "code": "bad_request",
    "message": "id required."
  }]
}

Customize

japi-errors enables developers to craft custom error objects. To do so, implement the ApiErrorCreator interface, then pass an instance of your creator to ApiError.creator(myApiErrorCreator)

To see a working example, check out this source code

Example:

// Create an api error creator
public class MyApiErrorCreator implements IApiErrorCreator {
    @Override
    public ApiError create(HttpStatus status, String message) {
        return new MyApiError(message);
    }

    @Override
    public ApiError create(HttpStatus status, Throwable t) {
        return new MyApiError(t.getMessage());
    }
}

// Create a custom api error object
// Add Json ignore properties (see source code link above)
public class MyApiError extends ApiError {
  @JsonProperty
  private String message;
  
  MyApiError() {
      super();
  }
  
  MyApiError(String message) {
    this.message = message;
  }
  
  public String getMessage() {
    return message;
  }
}

Examples

Check out the following examples to see japi-errors in use:

• with Spring MVC

License

Apache 2

Versions

Version
0.4.1 Nov 4, 2018