Public Repository

Last pushed: 9 months ago
Short Description
Friend Management Demo
Full Description

User Stories

  1. As a user, I need an API to create a friend connection between two email addresses.

This is a POST request with the following context path (http://localhost:8090/friend/createFriendConnection)
If there is already a connection between the two friends. API will response with the following message: "Already have existing friend connection found."
The API should receive the following JSON request:
{
"friends":
[
"sk@example.com",
"jm@example.com"
]
}

  1. As a user, I need an API to retrieve the friends list for an email address.

This is a POST request with the following context path (http://localhost:8090/friends/findFriend)
If there is no friends found. API will response with the following message: "No Friend List found."
The API should receive the following JSON request:
{
"email": "sk@example.com"
}

  1. As a user, I need an API to retrieve the common friends list between two email addresses.

This is a POST request with the following context path (http://localhost:8090/friend/findCommonFriend)
If there is no common friends found. API will response with the following message: "No Common Friend List found."
The API should receive the following JSON request:
{
"friends":
[
"jm@example.com",
"sk@example.com"
]
}

  1. As a user, I need an API to subscribe to updates for an email address.

This is a POST request with the following context path (http://localhost:8090/friend/subscribe)
Subscription will fail if any of the email account details cannot be found. API will response with the following message: "Invalid Account found."
The API should receive the following JSON request:
{
"requestor": "jm@example.com",
"target": "sk@example.com"
}

  1. As a user, I need an API to block updates for an email address.

This is a POST request with the following context path (http://localhost:8090/friend/block)
Block friend update will fail if any of the email account details cannot be found. API will response with the following message: "Invalid Account found."
The API should receive the following JSON request:
{
"requestor": "cy@example.com",
"target": "sk@example.com"
}

  1. As a user, I need an API to retrieve all email addresses that can receive updates for an email address.

This is a POST request with the following context path (http://localhost:8090/friend/broadcast)
Block friend update will fail if any of the email account details cannot be found. API will response with the following message: "Invalid Account found."
The API should receive the following JSON request:
{
"sender": "sk@example.com",
"text": "Hello World! All my Friends"
}

Docker Pull Command
Owner
cheeregoer