Basic REST Service

This application is an example REST API that REST services can be modeled after. It includes several basic features of a modern production level REST service.

This branch features the most basic structure and framework for an average production level REST service

These basic features include:

1. Basic package structure
2. Spring Security - Basic Authentication
3. Swagger
4. Spring Boot Actuator
5. Unit Test examples
6. Spring Profiles
7. Enabled Configuration Properties
8. Custom Exception Handler for error handling
9. Logback
10. JaCoCo Test Coverage Plugin

Instructions

Please clone this repo to your run the code to see how it works. Play around with it! Experiment with all the above noted features to get a deeper understanding of how they work so that you can confidently implement them into your own code.

Swagger

    http://localhost:8080/swagger-ui.html

Spring Actuator

GET /actuator/health

get status of application

GET /actuator/info

get git information of application

API Endpoints

POST /test

Required Headers

header name	value	description	required
Content-Type	application/json	request object type	true
Authorization	-	Basic Authentication	true

curl Request

curl -i -X POST \
  http://localhost:8080/test \
  -H 'Accept: */*' \
  -H 'Accept-Encoding: gzip, deflate' \
  -H 'Authorization: Basic dGVzdDp0ZXN0MTAw' \
  -H 'Connection: keep-alive' \
  -H 'Content-Length: 27' \
  -H 'Content-Type: application/json' \
  -H 'Cookie: JSESSIONID=639473E390EE936177B1C7BEDEFFC42F' \
  -H 'Host: localhost:8080' \
  -H 'User-Agent: PostmanRuntime/7.16.3' \
  -d '{
	"msisdn": "1234567890"
}'

curl Response

HTTP/1.1 200
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 15 Sep 2019 08:11:18 GMT

{"status":"Success"}

Request Body

{
    "msisdn": "1234567890"
}

Response Body

{
  "baseError": {
    "code": "string",
    "explanation": "string",
    "reason": "string"
  },
  "body": {
    "status": "string"
  }
}

Failure Response

{
  "baseError": {
    "code": "string",
    "explanation": "string",
    "reason": "string"
  },
  "body": {}
}

POST /testWithoutAuth

Required Headers

header name	value	description	required
Content-Type	application/json	request object type	true
Authorization	-	Basic Authentication	false

curl Request

curl -i -X POST \
  http://localhost:8080/testWithoutAuth \
  -H 'Accept: */*' \
  -H 'Accept-Encoding: gzip, deflate' \
  -H 'Connection: keep-alive' \
  -H 'Content-Length: 27' \
  -H 'Content-Type: application/json' \
  -H 'Cookie: JSESSIONID=639473E390EE936177B1C7BEDEFFC42F' \
  -H 'Host: localhost:8080' \
  -H 'User-Agent: PostmanRuntime/7.16.3' \
  -d '{
	"msisdn": "1234567890"
}'

curl Response

HTTP/1.1 200
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 15 Sep 2019 09:42:21 GMT

{ "baseError": { "code": "string", "explanation": "string", "reason": "string" }, "body": { "status": "string" } }

Request Body

{
    "msisdn": "1234567890"
}

Response Body

{
  "baseError": {
    "code": "string",
    "explanation": "string",
    "reason": "string"
  },
  "body": {
    "status": "string"
  }
}

Failure Response

{
  "baseError": {
    "code": "string",
    "explanation": "string",
    "reason": "string"
  },
  "body": {}
}