Skip to content

Commit 38f40f4

Browse files
author
harshbhardwaj
committed
Update Read.me and .gitignore
1 parent e33e357 commit 38f40f4

File tree

2 files changed

+36
-1
lines changed

2 files changed

+36
-1
lines changed

request-proxy-service/.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
README.md
21
.gradle
32
build/
43
!gradle/wrapper/gradle-wrapper.jar

request-proxy-service/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Request Proxy Service
2+
3+
The System has be been built using Spring boot framework, with an exposed endpoint/REST API
4+
* host/api/v1/reply, where host is the server where the system has been deployed or running, v1 is for the versioning of the API
5+
* for local testing or postman testing : use localhost:8090/api/v1/reply
6+
7+
## Requirements
8+
9+
* Java 1.8
10+
* Gradle 4.10.3
11+
12+
## How to run it?
13+
Do :> gradle bootRun
14+
15+
## For running unit test and integration test
16+
17+
Do:> gradle test
18+
19+
## For running unit test and integration test with additional information
20+
21+
Do:> gradle test -info or gradle test -i
22+
23+
## Improvement to be covered
24+
25+
* More Error handling can be done around the URL execution
26+
27+
* More Integration test can be covered under failure cases like, request limit exceeds,
28+
connection refused, server not found.
29+
30+
* For Recording client activities making request to the service distributed caching can used,
31+
currently a simple TransactionService has been created to do the same.
32+
33+
34+
35+
36+

0 commit comments

Comments
 (0)