From ea02a4f16f082497378fd78725b69065534f5e85 Mon Sep 17 00:00:00 2001
From: Victor Smirnov <53015676+vityaman@users.noreply.github.com>
Date: Thu, 19 Sep 2024 16:03:09 +0300
Subject: [PATCH] #1 Host OpenAPI specification web page (#4)

---
 .vscode/settings.json                         |  3 +
 compose.yml                                   | 15 +++
 matchmaker/api/pom.xml                        |  2 +-
 .../main/resources/static/openapi}/api.yml    |  2 +-
 matchmaker/app/pom.xml                        | 50 ++++++++++
 .../ru/ifmo/se/dating/matchmaker/Main.java    | 11 +++
 .../app/src/main/resources/application.yml    |  6 ++
 matchmaker/pom.xml                            |  2 +
 matchmaker/server/pom.xml                     | 90 ++++++++++++++++++
 people/api/pom.xml                            |  2 +-
 .../main/resources/static/openapi}/api.yml    |  2 +-
 people/app/pom.xml                            | 50 ++++++++++
 .../java/ru/ifmo/se/dating/people/Main.java   | 11 +++
 people/app/src/main/resources/application.yml |  6 ++
 people/pom.xml                                |  2 +
 people/server/pom.xml                         | 90 ++++++++++++++++++
 pom.xml                                       | 94 ++++++++++++++++++-
 17 files changed, 432 insertions(+), 6 deletions(-)
 create mode 100644 .vscode/settings.json
 create mode 100644 compose.yml
 rename {people/api/src/main/resources => matchmaker/api/src/main/resources/static/openapi}/api.yml (96%)
 create mode 100644 matchmaker/app/pom.xml
 create mode 100644 matchmaker/app/src/main/java/ru/ifmo/se/dating/matchmaker/Main.java
 create mode 100644 matchmaker/app/src/main/resources/application.yml
 create mode 100644 matchmaker/server/pom.xml
 rename {matchmaker/api/src/main/resources => people/api/src/main/resources/static/openapi}/api.yml (96%)
 create mode 100644 people/app/pom.xml
 create mode 100644 people/app/src/main/java/ru/ifmo/se/dating/people/Main.java
 create mode 100644 people/app/src/main/resources/application.yml
 create mode 100644 people/server/pom.xml

diff --git a/.vscode/settings.json b/.vscode/settings.json
new file mode 100644
index 00000000..e0f15db2
--- /dev/null
+++ b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+    "java.configuration.updateBuildConfiguration": "automatic"
+}
\ No newline at end of file
diff --git a/compose.yml b/compose.yml
new file mode 100644
index 00000000..3527e24f
--- /dev/null
+++ b/compose.yml
@@ -0,0 +1,15 @@
+services:
+  matchmaker:
+    image: eclipse-temurin:17-jdk-alpine
+    volumes:
+      - ./matchmaker/app/target/matchmaker-app-1.0.0.jar:/matchmaker.jar
+    command: java -jar /matchmaker.jar
+    ports:
+      - 8080:8080
+  people:
+    image: eclipse-temurin:17-jdk-alpine
+    volumes:
+      - ./people/app/target/people-app-1.0.0.jar:/people.jar
+    command: java -jar /people.jar
+    ports:
+      - 8081:8080
diff --git a/matchmaker/api/pom.xml b/matchmaker/api/pom.xml
index 43438755..73b4557d 100644
--- a/matchmaker/api/pom.xml
+++ b/matchmaker/api/pom.xml
@@ -11,7 +11,7 @@
 
     <artifactId>matchmaker-api</artifactId>
     <version>1.0.0</version>
-    <packaging>pom</packaging>
+    <packaging>jar</packaging>
     <name>matchmaker-api</name>
 
     <build>
diff --git a/people/api/src/main/resources/api.yml b/matchmaker/api/src/main/resources/static/openapi/api.yml
similarity index 96%
rename from people/api/src/main/resources/api.yml
rename to matchmaker/api/src/main/resources/static/openapi/api.yml
index 9affe3ae..aaa5b955 100644
--- a/people/api/src/main/resources/api.yml
+++ b/matchmaker/api/src/main/resources/static/openapi/api.yml
@@ -2,7 +2,7 @@
   swagger: "2.0"
   info: 
     version: "1.0.0"
-    title: "Swagger Petstore"
+    title: "Swagger Petstore: Matchmaker"
     description: "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification"
     termsOfService: "http://swagger.io/terms/"
     contact: 
diff --git a/matchmaker/app/pom.xml b/matchmaker/app/pom.xml
new file mode 100644
index 00000000..e3ffcfc9
--- /dev/null
+++ b/matchmaker/app/pom.xml
@@ -0,0 +1,50 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>ru.ifmo.se.dating</groupId>
+        <artifactId>matchmaker</artifactId>
+        <version>1.0.0</version>
+    </parent>
+
+    <artifactId>matchmaker-app</artifactId>
+    <version>1.0.0</version>
+    <packaging>jar</packaging>
+    <name>matchmaker-app</name>
+
+    <dependencies>
+        <dependency>
+            <groupId>ru.ifmo.se.dating</groupId>
+            <artifactId>matchmaker-server</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+                <configuration>
+                    <mainClass>ru.ifmo.se.dating.matchmaker.Main</mainClass>
+                </configuration>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>repackage</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+</project>
diff --git a/matchmaker/app/src/main/java/ru/ifmo/se/dating/matchmaker/Main.java b/matchmaker/app/src/main/java/ru/ifmo/se/dating/matchmaker/Main.java
new file mode 100644
index 00000000..6845364d
--- /dev/null
+++ b/matchmaker/app/src/main/java/ru/ifmo/se/dating/matchmaker/Main.java
@@ -0,0 +1,11 @@
+package ru.ifmo.se.dating.matchmaker;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.SpringApplication;
+
+@SpringBootApplication
+public class Main {
+    public static void main(String[] args) {
+        SpringApplication.run(Main.class, args);
+    }
+}
diff --git a/matchmaker/app/src/main/resources/application.yml b/matchmaker/app/src/main/resources/application.yml
new file mode 100644
index 00000000..9ec99f3b
--- /dev/null
+++ b/matchmaker/app/src/main/resources/application.yml
@@ -0,0 +1,6 @@
+springdoc:
+  api-docs:
+    path: /openapi
+  swagger-ui:
+    url: /openapi/api.yml
+    path: /swagger-ui.html
diff --git a/matchmaker/pom.xml b/matchmaker/pom.xml
index 99a4709f..ec5ca8d8 100644
--- a/matchmaker/pom.xml
+++ b/matchmaker/pom.xml
@@ -16,5 +16,7 @@
 
     <modules>
         <module>api</module>
+        <module>app</module>
+        <module>server</module>
     </modules>
 </project>
diff --git a/matchmaker/server/pom.xml b/matchmaker/server/pom.xml
new file mode 100644
index 00000000..cb35c76e
--- /dev/null
+++ b/matchmaker/server/pom.xml
@@ -0,0 +1,90 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>ru.ifmo.se.dating</groupId>
+        <artifactId>matchmaker</artifactId>
+        <version>1.0.0</version>
+    </parent>
+
+    <artifactId>matchmaker-server</artifactId>
+    <version>1.0.0</version>
+    <packaging>jar</packaging>
+    <name>matchmaker-server</name>
+
+    <dependencies>
+        <dependency>
+            <groupId>ru.ifmo.se.dating</groupId>
+            <artifactId>matchmaker-api</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>io.swagger.core.v3</groupId>
+            <artifactId>swagger-annotations</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.swagger.core.v3</groupId>
+            <artifactId>swagger-models</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.openapitools</groupId>
+            <artifactId>jackson-databind-nullable</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-web</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-context</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>javax.validation</groupId>
+            <artifactId>validation-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>javax.servlet</groupId>
+            <artifactId>javax.servlet-api</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>javax.annotation</groupId>
+            <artifactId>javax.annotation-api</artifactId>
+            <version>1.3.2</version>
+        </dependency>
+
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.openapitools</groupId>
+                <artifactId>openapi-generator-maven-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <configuration>
+                            <inputSpec>${project.basedir}/../api/src/main/resources/static/openapi/api.yml</inputSpec>
+                            <generatorName>spring</generatorName>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+</project>
diff --git a/people/api/pom.xml b/people/api/pom.xml
index c86d5b75..c7ffe838 100644
--- a/people/api/pom.xml
+++ b/people/api/pom.xml
@@ -11,7 +11,7 @@
 
     <artifactId>people-api</artifactId>
     <version>1.0.0</version>
-    <packaging>pom</packaging>
+    <packaging>jar</packaging>
     <name>people-api</name>
 
     <build>
diff --git a/matchmaker/api/src/main/resources/api.yml b/people/api/src/main/resources/static/openapi/api.yml
similarity index 96%
rename from matchmaker/api/src/main/resources/api.yml
rename to people/api/src/main/resources/static/openapi/api.yml
index 9affe3ae..c5aaf3c3 100644
--- a/matchmaker/api/src/main/resources/api.yml
+++ b/people/api/src/main/resources/static/openapi/api.yml
@@ -2,7 +2,7 @@
   swagger: "2.0"
   info: 
     version: "1.0.0"
-    title: "Swagger Petstore"
+    title: "Swagger Petstore: People"
     description: "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification"
     termsOfService: "http://swagger.io/terms/"
     contact: 
diff --git a/people/app/pom.xml b/people/app/pom.xml
new file mode 100644
index 00000000..6a3733d1
--- /dev/null
+++ b/people/app/pom.xml
@@ -0,0 +1,50 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>ru.ifmo.se.dating</groupId>
+        <artifactId>people</artifactId>
+        <version>1.0.0</version>
+    </parent>
+
+    <artifactId>people-app</artifactId>
+    <version>1.0.0</version>
+    <packaging>jar</packaging>
+    <name>people-app</name>
+
+    <dependencies>
+        <dependency>
+            <groupId>ru.ifmo.se.dating</groupId>
+            <artifactId>people-server</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+                <configuration>
+                    <mainClass>ru.ifmo.se.dating.people.Main</mainClass>
+                </configuration>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>repackage</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+</project>
diff --git a/people/app/src/main/java/ru/ifmo/se/dating/people/Main.java b/people/app/src/main/java/ru/ifmo/se/dating/people/Main.java
new file mode 100644
index 00000000..ac8bb102
--- /dev/null
+++ b/people/app/src/main/java/ru/ifmo/se/dating/people/Main.java
@@ -0,0 +1,11 @@
+package ru.ifmo.se.dating.people;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.SpringApplication;
+
+@SpringBootApplication
+public class Main {
+    public static void main(String[] args) {
+        SpringApplication.run(Main.class, args);
+    }
+}
diff --git a/people/app/src/main/resources/application.yml b/people/app/src/main/resources/application.yml
new file mode 100644
index 00000000..9ec99f3b
--- /dev/null
+++ b/people/app/src/main/resources/application.yml
@@ -0,0 +1,6 @@
+springdoc:
+  api-docs:
+    path: /openapi
+  swagger-ui:
+    url: /openapi/api.yml
+    path: /swagger-ui.html
diff --git a/people/pom.xml b/people/pom.xml
index fddac7dc..651b6e43 100644
--- a/people/pom.xml
+++ b/people/pom.xml
@@ -16,5 +16,7 @@
 
     <modules>
         <module>api</module>
+        <module>app</module>
+        <module>server</module>
     </modules>
 </project>
diff --git a/people/server/pom.xml b/people/server/pom.xml
new file mode 100644
index 00000000..df1474e1
--- /dev/null
+++ b/people/server/pom.xml
@@ -0,0 +1,90 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>ru.ifmo.se.dating</groupId>
+        <artifactId>people</artifactId>
+        <version>1.0.0</version>
+    </parent>
+
+    <artifactId>people-server</artifactId>
+    <version>1.0.0</version>
+    <packaging>jar</packaging>
+    <name>people-server</name>
+
+    <dependencies>
+        <dependency>
+            <groupId>ru.ifmo.se.dating</groupId>
+            <artifactId>people-api</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>io.swagger.core.v3</groupId>
+            <artifactId>swagger-annotations</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.swagger.core.v3</groupId>
+            <artifactId>swagger-models</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.openapitools</groupId>
+            <artifactId>jackson-databind-nullable</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-web</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-context</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>javax.validation</groupId>
+            <artifactId>validation-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>javax.servlet</groupId>
+            <artifactId>javax.servlet-api</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>javax.annotation</groupId>
+            <artifactId>javax.annotation-api</artifactId>
+            <version>1.3.2</version>
+        </dependency>
+
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.openapitools</groupId>
+                <artifactId>openapi-generator-maven-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <configuration>
+                            <inputSpec>${project.basedir}/../api/src/main/resources/static/openapi/api.yml</inputSpec>
+                            <generatorName>spring</generatorName>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+</project>
diff --git a/pom.xml b/pom.xml
index f44dcd1e..7b0f5bfe 100644
--- a/pom.xml
+++ b/pom.xml
@@ -22,6 +22,92 @@
 
     <dependencyManagement>
         <dependencies>
+            <dependency>
+                <groupId>ru.ifmo.se.dating</groupId>
+                <artifactId>matchmaker-api</artifactId>
+                <version>1.0.0</version>
+            </dependency>
+            <dependency>
+                <groupId>ru.ifmo.se.dating</groupId>
+                <artifactId>matchmaker-server</artifactId>
+                <version>1.0.0</version>
+            </dependency>
+
+            <dependency>
+                <groupId>ru.ifmo.se.dating</groupId>
+                <artifactId>people-api</artifactId>
+                <version>1.0.0</version>
+            </dependency>
+            <dependency>
+                <groupId>ru.ifmo.se.dating</groupId>
+                <artifactId>people-server</artifactId>
+                <version>1.0.0</version>
+            </dependency>
+
+            <dependency>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-starter-web</artifactId>
+                <version>3.3.3</version>
+            </dependency>
+            <dependency>
+                <groupId>org.springframework</groupId>
+                <artifactId>spring-web</artifactId>
+                <version>6.1.13</version>
+            </dependency>
+            <dependency>
+                <groupId>org.springframework</groupId>
+                <artifactId>spring-context</artifactId>
+                <version>6.1.13</version>
+            </dependency>
+            <dependency>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot</artifactId>
+                <version>3.3.3</version>
+            </dependency>
+            <dependency>
+               <groupId>org.springdoc</groupId>
+               <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+               <version>2.6.0</version>
+            </dependency>
+
+            <dependency>
+                <groupId>io.swagger.core.v3</groupId>
+                <artifactId>swagger-annotations</artifactId>
+                <version>2.2.23</version>
+            </dependency>
+            <dependency>
+                <groupId>io.swagger.core.v3</groupId>
+                <artifactId>swagger-models</artifactId>
+                <version>2.2.23</version>
+            </dependency>
+            <dependency>
+                <groupId>org.openapitools</groupId>
+                <artifactId>jackson-databind-nullable</artifactId>
+                <version>0.2.6</version>
+            </dependency>
+
+            <dependency>
+                <groupId>javax.validation</groupId>
+                <artifactId>validation-api</artifactId>
+                <version>2.0.1.Final</version>
+            </dependency>
+            <dependency>
+                <groupId>javax.servlet</groupId>
+                <artifactId>javax.servlet-api</artifactId>
+                <version>4.0.1</version>
+            </dependency>
+            <dependency>
+                <groupId>javax.annotation</groupId>
+                <artifactId>javax.annotation-api</artifactId>
+                <version>1.3.2</version>
+            </dependency>
+
+            <dependency>
+                <groupId>com.fasterxml.jackson.core</groupId>
+                <artifactId>jackson-databind</artifactId>
+                <version>2.17.2</version>
+            </dependency>
+
         </dependencies>
     </dependencyManagement>
 
@@ -30,7 +116,6 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
-                <version>3.11.0</version>
             </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
@@ -83,6 +168,11 @@
                     </configuration>
                 </plugin>
 
+                <plugin>
+			    	<groupId>org.springframework.boot</groupId>
+			    	<artifactId>spring-boot-maven-plugin</artifactId>
+			    </plugin>
+
                 <plugin>
                     <groupId>org.openapitools</groupId>
                     <artifactId>openapi-generator-maven-plugin</artifactId>
@@ -93,7 +183,7 @@
                                 <goal>generate</goal>
                             </goals>
                             <configuration>
-                                <inputSpec>${project.basedir}/src/main/resources/api.yml</inputSpec>
+                                <inputSpec>${project.basedir}/src/main/resources/static/openapi/api.yml</inputSpec>
                                 <configOptions>
                                     <sourceFolder>src/java/main</sourceFolder>
                                 </configOptions>