Update README.md
authorFabian <e1227328@student.tuwien.ac.at>
Sun, 25 Nov 2018 20:11:03 +0000 (21:11 +0100)
committerFabian <e1227328@student.tuwien.ac.at>
Sun, 25 Nov 2018 20:11:03 +0000 (21:11 +0100)
service-reporting/README.md

index 0fd645c47b4482b4906805785a346020ba64d65b..08ec2e92ab09cd2fb775a372316b802fc8dc1afb 100644 (file)
@@ -1,19 +1,28 @@
 # PDF Service
 
-Provides an API interface to generate PDF reports for terms and their sentiment analysis results. The service uses an .NET Core wrapper for the wkhtmltopdf library to generate pdf out of html code.
+Provides a REST-API to generate PDF reports for terms and their sentiment analysis results. The service uses an .NET Core wrapper for the wkhtmltopdf library to generate pdf out of html code.
 
 `GET`: `/` Shows a demo page  
 - param: none
 - return: pdf file
 
 `POST`: `/generatePDF/` Generates a pdf report for the given terms
-- param: Term[] as Content-Type: `application/json`
+- param: Term[] as Content-Type: `application/json`  
 e.g. body of request
-```javascript
+```json
 [
-  { "name": "term 1", "sentiment": 0.1 },
-  { "name": "term 2", "sentiment": 0.3 },
-  { "name": "term 3", "sentiment": 0.7 }
+  {
+    "name": "term 1",
+    "sentiment": 0.1
+  },
+  {
+    "name": "term 2",
+    "sentiment": 0.3
+  },
+  {
+    "name": "term 3",
+    "sentiment": 0.7
+  }
 ]
 ``` 
 - return: pdf file
@@ -24,7 +33,7 @@ Term(string `Name`, double `Sentiment`)
 ## run with docker
 
 - `docker build -t service-reporting .`    
-- `docker run -p YOUR_PORT:80 service-reporting:latest`
+- `docker run -p YOUR_PORT:8083 service-reporting:latest`
 
 ## run local
 ### requirements