• Introduction
• Deployment
• API Endpoints

This is a restful web application that exposes a few endpoints. The project needs the following softwares to be installed.

• Java 8
• Apache Maven 3.x installed.

There are two ways to deploy the web application.

1. As this is a Maven project, it can be imported in an IDE such as Eclipse or IntelliJ as a Maven Project.

• Create a Run configuration -> Java Application. Once done, select App as a main-class. The application will be deployed to an embedded TOMCAT container

• Build and compile the project from command line. Navigate to the project root using the command line, and execute the following command mvn spring-boot:run. You will need maven plugin for that.

The RESTful services can be invoked after either steps is performed.

IMPORTANT: these two instructions are mutually exclusive.

Following are the list of endpoints supported the restful application

 curl -XGET 'http://localhost:8080/takehome/rest/helloworld'

Returns "Hello World" as string response.

Response

A success response will include:

● a status code of 200 Created

The sample response is given below

Hello World

Returns a json array of the most frequent words in sorted alphabetical order.

curl -XGET -H "Content-type: application/json; charset=UTF-8" -d '{"paragraph": "Here we are"}' 'http://localhost:8080/takehome/rest/frequentwords'

Request

The sample request is given below

{
    "paragraph": "we had everything before us."
}

Request

The request body is shown below

Response

A successful response will be a json array.

● a status code of 200 OK

● Response body properties

Each json object consists of the following

The example of a successful response is given below

[
 {"But": 9}
]

1. The request body is either missing, or has no content associated with paragraph.

In case of an error, the response payload will have the following characeristics.

The error response is defined as follows.

● HTTP status code 400 (Bad Request)

● Response Body Properties

The sample response

{  
  "errors":[  
    {  
      "code":400,
      "message":"No paragraph content found"
    }
  ]
}

curl -XGET 'http://localhost:8080/takehome/rest/fibonacci?n=10'

The implementation returns an array of fibocci sequences.

The sample request is given below

Response

● a status code of 200 OK ● Response Body Properties

For n = 10, the sample output response would be

[0,1,1,2,3,5,8,13,21,34]

curl -XGET 'http://localhost:8080/takehome/rest/deadlock?timeInSeconds=15'

The function checks if the deadlock has occurred after specified period of time.

The sample request is given below

Response

● a status code of 200 OK

● Response Body Properties

The sample response is given below

  {'deadlock': true}

curl -XPOST -H "Content-type: application/json; charset=UTF-8" -d '{"firstName": "John", "lastName": "Doe"}' 'http://localhost:8080/takehome/person/'

This creates an entity of type Person in the database.

The sample request body is given below

The example of request body is given below

{
    "firstName": "John",
    "lastName": "Doe"
}

Response

The response payload returns a unique person identifier associated with the person.

● a status code of 201 Created ● Response Body Properties

The sample response body is

{
    "personId": "ABCDE12345
}

1. The request body does not contain either first or last name or both, or that the request body is empty.

In this case, 400 error is returned. The sample response

{  
  "errors":[  
    {  
      "code":400,
      "message":"The input was invalid. Please check if either first name or last name is missing."
    }
  ]
}

curl -XGET 'http://localhost:8080/takehome/person/{personId}'

Returns an entity of type Person from the database.

The sample request body is given below

Response

The response payload returns a unique person entity.

● a status code of 200 OK

● Response Body Properties

The example of request body is given below

{
    "firstName": "John",
    "lastName": "Doe"
}

1. Person entity does not exist for the unique person identifier.

In this case, 404 error is returned. The sample response

{  
  "errors":[  
    {  
      "code":404,
      "message":"No record was found for the input."
    }
  ]
}

curl -XDELETE 'http://localhost:8080/takehome/person/{personId}'

Returns an entity of type Person from the database.

The sample request body is given below

Response

The response payload returns the success of the operation.

● a status code of 200 OK

● Response Body Properties

The example of request body is given below

{
    "success": true
}

1. Person entity does not exist for the unique person identifier.

In this case, 404 error is returned. The sample response

{  
  "errors":[  
    {  
      "code":404,
      "message":"No record was found for the input."
    }
  ]
}

curl -XGET 'http://localhost:8080/takehome/service/get'

The function checks if the deadlock has occurred after specified period of time.

Response

● a status code of 200 OK

● Response Body Properties

The sample response is given below

   [
   {
    "userId": 1,
    "id": 1,
    "title": "title text",
    "body": "body text"
  }
  ]