indrabasak / spring-hateoas-example

Spring HATEOAS Example

This is a simple example of using HATEOAS with Spring Boot. It contains examples on how to use PagedResourcesAssembler, ResourceAssemblerSupport, etc.

Build

To build the JAR, execute the following command from the parent directory:

mvn clean install

This should build the following Spring Boot jar, spring-hateoas-example-1.0.0.jar, located in target folder.

Run

To start the server, run the executable jar from the command:

$ java -jar target/spring-hateoas-example-1.0.0.jar

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::        (v2.0.4.RELEASE)

2018-08-05 00:53:04.981  INFO 4274 --- [           main] com.basaki.hateoas.Application           : Starting Application on macs-MacBook-Pro.local with PID 4274 (/Users/indra/Development/examples/spring-hateoas-example/target/spring-hateoas-example-1.0.0.jar started by indra in /Users/indra/Development/examples/spring-hateoas-example)
...
2018-08-05 00:53:11.952  INFO 4274 --- [           main] s.d.s.w.s.ApiListingReferenceScanner     : Scanning for api listing references
2018-08-05 00:53:12.188  INFO 4274 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2018-08-05 00:53:12.192  INFO 4274 --- [           main] com.basaki.hateoas.Application           : Started Application in 7.802 seconds (JVM running for 8.373)

This should start the server at port 8080. From the browser, you can access the server swagger UI page at https://localhost:8080/swagger-ui.html.

Usage

Create a Book

Request

curl -X POST "http://localhost:8080/books" -H "accept: */*" -H "Content-Type: application/json" -d "{ \"title\": \"Indra's Book\", \"author\": \"Indra\"}"

Response

{
  "id": "0a2dbb50-4ff7-48a2-b89f-4ee9d19c90b6",
  "title": "Indra's Book",
  "author": "Indra",
  "_links": {
    "self": {
      "href": "http://localhost:8080/books/0a2dbb50-4ff7-48a2-b89f-4ee9d19c90b6"
    }
  }
}

Retrieve A Book

Request

curl -X GET "http://localhost:8080/books/0a2dbb50-4ff7-48a2-b89f-4ee9d19c90b6" -H "accept: application/json"

Response

{
  "id": "0a2dbb50-4ff7-48a2-b89f-4ee9d19c90b6",
  "title": "Indra's Book",
  "author": "Indra",
  "_links": {
    "self": {
      "href": "http://localhost:8080/books/0a2dbb50-4ff7-48a2-b89f-4ee9d19c90b6"
    }
  }
}

Retrieve All Books

Request

curl -X GET "http://localhost:8080/books?page=0&size=1" -H "accept: application/json"

Response

{
  "_embedded": {
    "bookList": [
      {
        "id": "df3372ef-a0a2-4569-982a-78c708d1f609",
        "title": "indra's book",
        "author": "indra"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "http://localhost:8080/books?page=0&size=20"
    }
  },
  "page": {
    "size": 20,
    "totalElements": 1,
    "totalPages": 1,
    "number": 0
  }
}