Introducing Spring Framework

Chapter 12 ■ Exposing a REST API
Table 12-2 shows the RESTful calls for the Spring application. You are going to use and extend the
DocumentService and create the DocumentController class. Your base URI will be
http://localhost:8080/mydocuments/.
Table 12-2. My Documents RESTful Design Over HTTP (http://localhost:8080/ch12/mydocuments/) -
DocumentController
HTTP Method PATH Description DocumentController Method Call
GET /documents Gets all the documents in the repository getDocuments
GET /documents/{id} Finds a document, providing the ID findDocument
POST /documents Creates a new document, will accept a Json
format document
PUT /documents/{id} Updates an existing document, passing an
ID and a Json format document
addDocument
updateDocument
DELETE /documents/{id} Deletes an existing document, passing an ID removeDocument
Let’s review the classes that will be refactored and modified by starting with the DocumentService class in
Listing 12-1.
Listing 12-1. DocumentService.java
package com.apress.isf.java.service;
import java.util.List;
import com.apress.isf.java.model.Document;
public interface DocumentService {
public List getAllDocuments();
public Document findDocumentById(String id);
public Document saveDocument(String id, Document document);
public Document removeDocumentById(String id);
public boolean updateLocationFromDocumentId(String documentId, String location);
}
In Listing 12-1, you added some new methods to the DocumentService class. This class exposes an entire
CRUD (Create-Read-Update-Delete) of the documents. You also added the saveDocument method that you use to
insert or update a document; you added a getAllDocuments method that will get all the documents available, you
added the removeDocumentById that will delete a document. Next, Listing 12-2 shows the implementation of the
DocumentService class.
170