Introduction

This project demonstrates a RESTful web service that allows managing two entities, a Person entity and a Message entity. A person can be the sender of a message or the receiver. The web service exposes end-points that allow clients to use GET and POST requests to manage these entities. In addition, there are other helpful queries that provide easier access to Person and Message entities such as the those listed below,

1. Get a list of messages by specifying a sender,

   GET /messages?senderId=:senderId,

   or by specifying a receiver,

   GET /messages?receiverId=:receiverId,

   or by specifying both,

   GET /messages?senderId=:senderId&receiverId=:receiverId

2. Get back useful links in the response JSON to navigate to related resources, such as - get a link to the related person resources in the response of the GET /messages request. like so,

   [{
       "message": {
           "id": 80,
           ...
           "messageDesc": "This is message one"
       },
       "links": [
           ...
       {
           "rel": "sender",
           "href": "http://localhost:8080/persons/1187"
       }
           ...
   }]
   

API Reference.

The API reference is available at API Reference. The documenatation was prepared using Spring RestDocs.

Try it out

You may see the API in action by clickling on the below links.

GET /messages

http://ec2-52-35-143-209.us-west-2.compute.amazonaws.com:8080/messages

GET /messages/messageId

http://ec2-52-35-143-209.us-west-2.compute.amazonaws.com:8080/messages/850

GET /messages?senderId=:senderId

http://ec2-52-35-143-209.us-west-2.compute.amazonaws.com:8080/messages?senderId=1260

GET /messages?receiverId=:receiverId

http://ec2-52-35-143-209.us-west-2.compute.amazonaws.com:8080/messages?receiverId=1262

GET /messages?senderId=:senderId&receiverId=:receiverId

http://ec2-52-35-143-209.us-west-2.compute.amazonaws.com:8080/messages?senderId=1260&receiverId=1262

How this web-service was developed.

This project was developed using Java and Spring framework. The Spring libraries used are Boot, Data JPA, MVC/Web, HATEOAS, Test, RestDocs.

The jar is deployed on AWS EC2 instance and uses RDS for storing the data.

---

👍 ❤️ 👏