ivan-tamayo / the-spring-rest-stack

the deck to my talk on building more powerful REST APIs

The Spring REST Stack

This code accompanies a talk that I deliver on RESTful service development with Spring.

• There are online versions of the talk. Notably, I presented it as a webinar on the SpringSourceDev channel.
• See the slides on my SlideShare.net page.
• This code lives at my GitHub page (joshlong) for this project the-spring-rest-stack.

The goals of this project are to demonstrate the development of a simple REST service with Spring. The REST service concerns itself with the domain of a simple CRM: a user manages a customer collection.

Breakdown of the Various Tiers

The Data and Service Tier

The data tier module services uses Spring Data JPA repositories, a standard SQL database, and Spring's standard transaction management infrastructure to build a service. This tier is configured by importing the class com.jl.crm.services.ServiceConfiguration. Currently there are two Spring profiles. One called production, which attempts to the SQL database configured in /code/services/src/main/resources/config.properties, and test, which manages an embedded H2 database which can be accessed at the embedded H2 database console web application with the configuration shown below.

The REST Tier

There are four web-tier modules, rest, hateoas, hateoas-data, and oauth, which demonstrate the evolution of a REST service implemented using Spring MVC to manage users and customers. The initial cut, rest, is fairly RESTful, but not HATEOAS and hypermedia compliant. The next cut, hateoas uses Spring HATEOAS to introduce hypermedia. This improvement, while welcome, is not without an associated cost in code. The next cut, hateoas-data, introduces Spring Data REST which reduces boilerplate code associated with managing data from the REST endpoint to the database. In the final cut, oauth, we introduce Spring Security and Spring Security OAuth to secure the API's from both prying eyes and unauthorized application clients.

The Client Tier

The social module is a Spring Social API binding for the OAuth 2.0-secured CRM REST API. The ClientExample demonstrates how to configure and use the Spring Social binding outside of a web container and demonstrates some of its uses.

The android module is a Spring Android-powered Android client that embeds the social client and uses it to support an Android mobile application.

Notes on Implementation

For a detailed walkthrough of all the code, please check out the tutorial.