From fbafbfe27bf8c1270f3448529974f36c3c7003d8 Mon Sep 17 00:00:00 2001
From: Rasmus Neikes <rasmus.neikes@gmail.com>
Date: Sun, 18 Aug 2024 21:36:58 +0200
Subject: [PATCH] added open api and readme.dm for general documentation.

---
 pom.xml                                   |  5 +++++
 readme.md                                 | 16 ++++++++++++++++
 src/main/resources/application.properties |  3 ++-
 3 files changed, 23 insertions(+), 1 deletion(-)
 create mode 100644 readme.md

diff --git a/pom.xml b/pom.xml
index 5a3c889..01e54f1 100644
--- a/pom.xml
+++ b/pom.xml
@@ -117,6 +117,11 @@
             <artifactId>javax.annotation-api</artifactId>
             <version>1.3.2</version>
         </dependency>
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+            <version>2.6.0</version>
+        </dependency>
     </dependencies>
 
     <build>
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..72af82a
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,16 @@
+# stktrk.com repository
+
+Might have to
+ - Build -> Build Project
+ - maven reload all projects
+ - generate sources
+ - mvn clean install
+ - To run
+   - mvn spring-boot:run
+   - in IntelliJ: Run Icon in `src/main/java/com/stktrk/app/AppApplication.java`
+
+http://localhost:9090/swagger-ui/index.html#/app-application/sayHello  
+http://localhost:9090/hello?myName=Rasmus  
+
+
+ 
diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties
index 6bc9859..650f1d8 100644
--- a/src/main/resources/application.properties
+++ b/src/main/resources/application.properties
@@ -1,2 +1,3 @@
 spring.application.name=app
-server.port=9090
\ No newline at end of file
+server.port=9090
+springdoc.swagger-ui.path=/swagger-ui.html
\ No newline at end of file