REST

{
  "message": "Validation Failed", (1)
  "errors": [ (2)
    {
      "resource": "Book", (3)
      "field": "title", (4)
      "code": "field_mandatory" (5)
    }
  ]
}

{
  "typ" : "JWT", (1)
  "alg" : "HS256" (2)
}

{
  "iss": "example.com", (1)
  "sub": "john", (2)
  "exp": 1300819380, (3)
  "clientIp": "127.0.0.1" (4)
}

{
  "username" : "john",
  "password" : "1234"
}

{
  "user" : {
    "fullName" : "John Smith",
    "username" : "john"
  },

  "token" : "123ACFF234...."
}

@Path("/books")
public class BookResource {

  @GET
  @Produces(MediaType.APPLICATION_JSON)
  public Response books(@QueryParam("orderBy")String field) { (1) (2)
    List<Book> books = findAllBooksOrderedBy(field);
    return Response.ok(books).build();
  }
}

@Path("/books")
public class BookResource {

  @GET
  @Produces(MediaType.APPLICATION_JSON)
  public Response books(@HeaderParam("user-agent")String userAgent) {
    //..
  }
}

@Path("/books")
public class BookResource {

  @GET
  @Produces(MediaType.APPLICATION_JSON)
  public Response books(@CookieParam("Last-Accessed")String lastAccessed) {
    //..
  }
}

@Path("/books")
public class BookResource {

  @POST (1)
  @Consumes(MediaType.APPLICATION_JSON) (2)
  public Response createBook(String jsonBook) { (3)
    Book book = fromJson(jsonBook); (4)
    book = insertBook(book);

    return Response.created(URI.create(book.getId())).build(); (5)
  }
}

@Path("/books")
public class BookResource {

  @PUT (1)
  @Path("{bookId: [0-9]+}")
  @Consumes(MediaType.APPLICATION_JSON)
  public Response updateBook(@PathParam("bookId") String bookId, String jsonBook) {
    Book book = fromJson(jsonBook);
    book = updateBook(book);

    return Response.noContent().build(); (2)
  }
}

@Path("/books")
public class BookResource {

  @DELETE (1)
  @Path("{bookId: [0-9]+}")
  @Consumes(MediaType.APPLICATION_JSON)
  public Response deleteBook(@PathParam("bookId") String bookId) {
    //delete

    return Response.noContent().build(); (2)
  }
}

@GET
@Produces(MediaType.APPLICATION_JSON)
public Response book(@PathParam("bookId") String bookId) {

  Book book = findBookById(bookId);

  if (book != null) {
    return Response.ok(book).build();
  } else {
    return Response.status(Status.NOT_FOUND).build(); (1)
  }
}

import javax.ws.rs.ext.Provider;
import javax.persistence.PersistenceException;

@Provider (1)
public class PersistenceExceptionMapper implements ExceptionMapper<PersistenceException> {

  @Override
  public Response toResponse(PersistenceException exception) { (2)
    return Response.status(Status.INTERNAL_SERVER_ERROR)
          .entity(createErrorMessage(exception.getMessage())).type("application/json").build(); (3)
  }
}

@Path("/books")
public class BookResource {
    //....
}

import javax.ws.rs.core.Application;
import javax.ws.rs.ApplicationPath;

@ApplicationPath("public") (1)
public class BookApplication extends Application {

  public Set<Class<?>> getClasses() {
    Set<Class<?>> s = new HashSet<Class<?>>();
    s.add(BookApplication.class); (2)
    return s;
  }
}

<web-app>
  <servlet>
    <display-name>BookApplication Servlet</display-name>
    <servlet-name>BookApplication</servlet-name>
    <init-param>
      <param-name>javax.ws.rs.Application</param-name>
      <param-value>myPackage.BookApplication</param-value>
    </init-param>
  </servlet>
  <servlet-mapping>
    <servlet-name>BookApplication</servlet-name>
    <url-pattern>/*</url-pattern>
  </servlet-mapping>
</web-app>

<dependencyManagement>
  <dependencies>
    <dependency>
    <groupId>org.jboss.arquillian</groupId> (1)
    <artifactId>arquillian-bom</artifactId>
    <version>1.1.7.Final</version>
    <scope>import</scope>
    <type>pom</type>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>org.apache.openejb</groupId> (2)
    <artifactId>arquillian-tomee-embedded</artifactId>
    <version>1.7.1</version>
    <scope>test</scope>
  </dependency>
  <dependency>
    <groupId>org.apache.openejb</groupId> (3)
    <artifactId>tomee-jaxrs</artifactId>
    <version>1.7.1</version>
    <scope>test</scope>
  </dependency>
</dependencies>

@RunWith(Arquillian.class) (1)
public class MoviesServiceTest {

  @Deployment (2)
  public static JavaArchive createDeploymentPackage() {
    return createDeploymentFile();
  }

  @EJB (3)
  MoviesService moviesService;

  @Test
  public void shouldCreateMovies() {
    (4)
  }
}

@Deployment
public static WebArchive createDeploymentPackage() {
  WebArchive deploymentFile = ShrinkWrap.create(WebArchive.class) (1)
  .addPackage("com.scytl.hibernate") (2)
  .addAsWebInfResource(EmptyAsset.INSTANCE, "beans.xml") (3)
  return deploymentFile;
}

package com.scytl.rest;


import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;

@Path("/person") (1)
public class PersonResource {

  private String OUTPUT = "{\n" +
  "  \"firstName\": \"John\",\n" +
  "  \"lastName\": \"Smith\",\n" +
  "  \"isAlive\": true,\n" +
  "  \"age\": 25,\n" +
  "  \"height_cm\": 167.6,\n" +
  "  \"address\": {\n" +
  "    \"streetAddress\": \"21 2nd Street\",\n" +
  "    \"city\": \"New York\",\n" +
  "    \"state\": \"NY\",\n" +
  "    \"postalCode\": \"10021-3100\"\n" +
  "  },\n" +
  "  \"phoneNumbers\": [\n" +
  "    {\n" +
  "      \"type\": \"home\",\n" +
  "      \"number\": \"212 555-1234\"\n" +
  "    },\n" +
  "    {\n" +
  "      \"type\": \"office\",\n" +
  "      \"number\": \"646 555-4567\"\n" +
  "    }\n" +
  "  ],\n" +
  "  \"children\": [],\n" +
  "  \"spouse\": null\n" +
  "}";

  @GET
  @Path("{personId}")
  @Produces(MediaType.APPLICATION_JSON)
  public Response person(@PathParam("personId") String bookId) {
    return Response.ok(OUTPUT).build(); (2)
  }

}

package com.scytl.rest;

import static com.jayway.restassured.RestAssured.get;
import static org.junit.Assert.assertThat;
import static org.hamcrest.CoreMatchers.is;


import com.jayway.restassured.path.json.JsonPath;
import org.jboss.arquillian.container.test.api.Deployment;
import org.jboss.arquillian.junit.Arquillian;
import org.jboss.arquillian.test.api.ArquillianResource;
import org.jboss.shrinkwrap.api.ShrinkWrap;
import org.jboss.shrinkwrap.api.spec.WebArchive;
import org.junit.Test;
import org.junit.runner.RunWith;

import javax.ws.rs.core.UriBuilder;
import java.io.InputStream;
import java.net.URI;
import java.net.URL;

@RunWith(Arquillian.class) (1)
public class PersonResourceTest {

  @Deployment(testable = false) (2)
  public static WebArchive createDeployment() {
    return ShrinkWrap.create(WebArchive.class, "persontest.war")
    .addClass(PersonResource.class);
  }

  @ArquillianResource (3)
  URL baseUrl;

  @Test
  public void shouldReturnExpectedPerson() {
    URI endpoint = UriBuilder.fromPath(baseUrl.toExternalForm()).path(PersonResource.class).path("1").build(); (4)
    InputStream response = get(endpoint).then().statusCode(200).extract().asInputStream(); (5)

    JsonPath jsonPath = new JsonPath(response);
    String firstName = jsonPath.getString("firstName"); (6)
    String streetAddress = jsonPath.getString("address.streetAddress"); (7)

    assertThat(firstName, is("John"));
    assertThat(streetAddress, is("21 2nd Street")); (8)
  }

}

public class Book {

  private long id;
  private String title;

  public Book(long id, String title) {
    this.title = title;
    this.id = id;
  }

  public String getTitle() {return title;}
  public int getId() {return 1;}
}

public class Chapter {

  private long id;
  private String title;
  private String content;

  private Book book;

  public Chapter(long id, String title, String content, Book book) {
    this.id = id;
    this.title = title;
    this.content = content;
    this.book = book;
  }

  public long getId() { return id; }
  public String getTitle() { return title; }
  public String getContent() { return content; }
  public Book getBook() { return book; }
}

public class Book {

  private long id;
  private String title;

  private List<Chapter> chapters = new ArrayList<Chapter>();

  public Book(long id, String title) {
    this.title = title;
    this.id = id;
  }

  public void addChapter(Chapter chapter) { this.chapters.add(chapter); }
  public List<Chapter> getChapters() { return chapters; }
  public String getTitle() { return title; }
  public long getId() { return id; }
}

@Path("/books")
public class BookResource {

  @GET
  @Path("{bookId: [0-9]+}/chapters")
  @Produces(MediaType.APPLICATION_JSON)
  public Response chapters(@PathParam("bookId")Long bookId) {
    Book book = findBookById(bookId);
    return Response.ok(book.getChapters()).build(); (1)

}

@Path("/books")
public class BookResource {

  @Path("{bookId: [0-9]+}") (1) (2)
  public Book chapters(@PathParam("bookId")Long bookId) {

    Book book = findBookById(bookId);
    return book; (3)
  }
}

public class Book {

  private long id;
  private String title;

  private List<Chapter> chapters = new ArrayList<Chapter>();

  public Book() {
  }

  public Book(long id, String title) {
    this.title = title;
    this.id = id;
  }

  public void addChapter(Chapter chapter) {
    this.chapters.add(chapter);
  }

  @GET (1)
  @Produces(MediaType.APPLICATION_JSON)
  @Path("/chapters") (2)
  public List<Chapter> getChapters() {
    return chapters; (3)
  }
}

@ApplicationPath("/v1") (1)
public class V1Application {

  @Override
  public Set<Class<?>> getClasses() {
    Set<Class<?>> s = new HashSet<Class<?>>();
    s.add(ChapterResourceV1.class); (2) (3)
    return s;
    }
}

public class ChapterResourceV1 {

  @GET
  @Path("/") (1)
  @Produces(MediaType.APPLICATION_JSON)
  public Chapter chapter() {
    return ...;
  }
}

@ApplicationPath("/v2") (1)
public class V2Application {

  @Override
  public Set<Class<?>> getClasses() {
    Set<Class<?>> s = new HashSet<Class<?>>();
    s.add(ChapterResourceV2.class);
    return s;
    }
}

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@HttpMethod("PATCH") (1)
public @interface PATCH {

}

@PATCH (1)
@Consumes("application/json-patch") (2)
public Response patch(JsonArray jsonObject) { (3)

  //...

  return Response.noContent().build();
}

@Inject
TemporaryFolder temporaryFolder;

@POST
@Path("/chunkedUpload")
@Consumes("*/*")
@Produces(MediaType.APPLICATION_JSON)
public Response chunked(InputStream reader) throws IOException {
  UUID uploadId = UUID.randomUUID(); (1)

  java.nio.file.Path file = temporaryFolder.newFile(uploadId.toString()); (2)
  long offset = IOUtil.copyToFile(file, reader, Integer.MAX_VALUE); (3)
  return Response
    .status(202)
    .entity("{\n" + "  \"uploadId\": \"" + uploadId + "\",\n"
      + "  \"offset\": " + offset + "\n" + "}").build();
}

@PUT
@Path("/chunkedUpload")
@Consumes("*/*")
@Produces(MediaType.APPLICATION_JSON)
public Response chunked(InputStream reader, @QueryParam("uploadId") String uploadId, @QueryParam("offset") Long offset) throws IOException {
  File file = new File(temporaryFolder.getRoot(), uploadId);

  if(isUploadIdValid(file)) {
    if(isOffsetValid(file, offset)) { (1)
      long newOffset = IOUtil.copyToFile(file.toPath(), reader, Integer.MAX_VALUE); (2)

      return Response.status(202).entity("{\n" +
        "  \"uploadId\": \""+uploadId+"\",\n" +
        "  \"offset\": " + (offset + newOffset) + "\n" +
        "}").build();

    } else {
      return Response.status(400).build();
    }
  } else {
    return Response.noContent().build();
  }
}

private boolean isOffsetValid(File file, long offset) {
  return file.length() == offset;
}

private boolean isUploadIdValid(File file) {
  return file.exists();
}

@POST
@Path("/commitChunkedUpload")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
public Response commit(@QueryParam("uploadId") String uploadId, String content) {
  File file = new File(temporaryFolder.getRoot(), uploadId);

  if(isUploadIdValid(file)) {
    JsonReader parser = Json.createReader(new StringReader(content));
    JsonObject readObject = parser.readObject(); (1)
    file.renameTo(new File(temporaryFolder.getRoot(), readObject.getString("filename"))); (2)

    return Response.created(URI.create(uploadId)).build();
  } else {
    return Response.noContent().build();
  }
}

@RunWith(Arquillian.class)
@WarpTest (1)
public class RestUploadTest {

  @Deployment
  public static final WebArchive deployment() {
    return ShrinkWrap
      .create(WebArchive.class)
      .addClasses(BoundedInputStream.class, IOUtil.class,
        P12Resource.class, TemporaryFolder.class)
      .addAsWebInfResource(EmptyAsset.INSTANCE, "beans.xml")
      .addAsLibraries(
        Maven.resolver().loadPomFromFile("pom.xml")
        .resolve("org.glassfish:javax.json")
        .withTransitivity().as(JavaArchive.class));
  }

  @ArquillianResource
  URL baseUrl;

  @Test
  @RunAsClient (2)
  public void shouldUploadContent() {
    Warp.initiate( (3)
        () -> {
          URI endpoint =
          UriBuilder.fromPath(baseUrl.toExternalForm())
            .path(P12Resource.class).path("chunkedUpload")
            .build();
          given().request().body("This is a test file.".getBytes())
            .post(endpoint).then().assertThat()
            .body("uploadId", notNullValue()).and()
            .body("offset", notNullValue());

        })
        .inspect(new Inspection() { (4)
          private static final long serialVersionUID = 1L;

          @Inject
          TemporaryFolder temporaryFolder;

          @AfterServlet
          public void assertCreatedFile() {
            asserThat(temporaryFolder.getRoot(), notNullValue());
          }

        });
  }
}