summaryrefslogtreecommitdiffstats
path: root/sliapi/springboot/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'sliapi/springboot/README.md')
-rw-r--r--sliapi/springboot/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/sliapi/springboot/README.md b/sliapi/springboot/README.md
new file mode 100644
index 000000000..5737072ef
--- /dev/null
+++ b/sliapi/springboot/README.md
@@ -0,0 +1,10 @@
+This directory contains a demo springboot implementation of the SLI-API healthcheck method.
+
+To start this server, run:
+
+java -jar -DserviceLogicDirectory=src/main/resources target/sliapi-springboot-{version}.jar
+
+This will start a servlet on port 8080. To test to that servlet, post a blank
+message to that port:
+
+curl http://127.0.0.1:8080/SLI-API:healthcheck -X POST -H "Content-Type: application/json" \ No newline at end of file