#1 Add example OpenAPI specifications (#3)

secs-dev · Sep 19, 2024 · 6f9e517 · 6f9e517
1 parent d56f5ed
commit 6f9e517
Show file tree

Hide file tree

Showing 9 changed files with 341 additions and 0 deletions.
diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
@@ -0,0 +1,33 @@
+name: Maven
+
+on:
+  push:
+    branches: 
+      - main
+      - lab-[1234]
+  pull_request:
+    branches:
+      - main
+      - lab-[1234]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: maven
+
+      - name: Compile
+        run: mvn compile
+
+      - name: Unit Test
+        run: mvn test
+
+      - name: Package
+        run: mvn package
diff --git a/.gitignore b/.gitignore
@@ -22,3 +22,6 @@
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
 replay_pid*
+
+# Maven
+target/
diff --git a/matchmaker/api/pom.xml b/matchmaker/api/pom.xml
@@ -0,0 +1,33 @@
+<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-api</artifactId>
+    <version>1.0.0</version>
+    <packaging>pom</packaging>
+    <name>matchmaker-api</name>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.openapitools</groupId>
+                <artifactId>openapi-generator-maven-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <configuration>
+                            <dryRun>true</dryRun>
+                            <generatorName>java</generatorName>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+</project>
diff --git a/matchmaker/api/src/main/resources/api.yml b/matchmaker/api/src/main/resources/api.yml
@@ -0,0 +1,46 @@
+---
+  swagger: "2.0"
+  info: 
+    version: "1.0.0"
+    title: "Swagger Petstore"
+    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: 
+      name: "Swagger API Team"
+    license: 
+      name: "MIT"
+  host: "petstore.swagger.io"
+  basePath: "/api"
+  schemes: 
+    - "http"
+  consumes: 
+    - "application/json"
+  produces: 
+    - "application/json"
+  paths: 
+    /pets: 
+      get: 
+        description: "Returns all pets from the system that the user has access to"
+        produces: 
+          - "application/json"
+        responses: 
+          "200":
+            description: "A list of pets."
+            schema: 
+              type: "array"
+              items: 
+                $ref: "#/definitions/Pet"
+  definitions: 
+    Pet: 
+      type: "object"
+      required: 
+        - "id"
+        - "name"
+      properties: 
+        id: 
+          type: "integer"
+          format: "int64"
+        name: 
+          type: "string"
+        tag: 
+          type: "string"
diff --git a/matchmaker/pom.xml b/matchmaker/pom.xml
@@ -0,0 +1,20 @@
+<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>itmo-dating</artifactId>
+        <version>1.0.0</version>
+    </parent>
+
+    <artifactId>matchmaker</artifactId>
+    <version>1.0.0</version>
+    <packaging>pom</packaging>
+    <name>matchmaker</name>
+
+    <modules>
+        <module>api</module>
+    </modules>
+</project>
diff --git a/people/api/pom.xml b/people/api/pom.xml
@@ -0,0 +1,33 @@
+<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-api</artifactId>
+    <version>1.0.0</version>
+    <packaging>pom</packaging>
+    <name>people-api</name>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.openapitools</groupId>
+                <artifactId>openapi-generator-maven-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <configuration>
+                            <dryRun>true</dryRun>
+                            <generatorName>java</generatorName>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+</project>
diff --git a/people/api/src/main/resources/api.yml b/people/api/src/main/resources/api.yml
@@ -0,0 +1,46 @@
+---
+  swagger: "2.0"
+  info: 
+    version: "1.0.0"
+    title: "Swagger Petstore"
+    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: 
+      name: "Swagger API Team"
+    license: 
+      name: "MIT"
+  host: "petstore.swagger.io"
+  basePath: "/api"
+  schemes: 
+    - "http"
+  consumes: 
+    - "application/json"
+  produces: 
+    - "application/json"
+  paths: 
+    /pets: 
+      get: 
+        description: "Returns all pets from the system that the user has access to"
+        produces: 
+          - "application/json"
+        responses: 
+          "200":
+            description: "A list of pets."
+            schema: 
+              type: "array"
+              items: 
+                $ref: "#/definitions/Pet"
+  definitions: 
+    Pet: 
+      type: "object"
+      required: 
+        - "id"
+        - "name"
+      properties: 
+        id: 
+          type: "integer"
+          format: "int64"
+        name: 
+          type: "string"
+        tag: 
+          type: "string"
diff --git a/people/pom.xml b/people/pom.xml
@@ -0,0 +1,20 @@
+<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>itmo-dating</artifactId>
+        <version>1.0.0</version>
+    </parent>
+
+    <artifactId>people</artifactId>
+    <version>1.0.0</version>
+    <packaging>pom</packaging>
+    <name>people</name>
+
+    <modules>
+        <module>api</module>
+    </modules>
+</project>
diff --git a/pom.xml b/pom.xml
@@ -0,0 +1,107 @@
+<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>
+
+    <groupId>ru.ifmo.se.dating</groupId>
+    <artifactId>itmo-dating</artifactId>
+    <version>1.0.0</version>
+    <packaging>pom</packaging>
+
+    <name>itmo-dating</name>
+
+    <modules>
+        <module>matchmaker</module>
+        <module>people</module>
+    </modules>
+
+    <properties>
+        <maven.compiler.release>17</maven.compiler.release>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+    <dependencyManagement>
+        <dependencies>
+        </dependencies>
+    </dependencyManagement>
+
+    <build>
+        <plugins>
+            <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>
+                <artifactId>maven-surefire-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-failsafe-plugin</artifactId>
+            </plugin>
+        </plugins>
+
+        <pluginManagement>
+            <plugins>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-compiler-plugin</artifactId>
+                    <version>3.10.1</version>
+                </plugin>
+
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-surefire-plugin</artifactId>
+                    <version>2.12.4</version>
+                    <configuration>
+                        <parallel>methods</parallel>
+                        <threadCount>10</threadCount>
+                    </configuration>
+                </plugin>
+
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-failsafe-plugin</artifactId>
+                    <version>2.22.1</version>
+                    <executions>
+                        <execution>
+                            <goals>
+                                <goal>integration-test</goal>
+                                <goal>verify</goal>
+                            </goals>
+                        </execution>
+                    </executions>
+                </plugin>
+
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-war-plugin</artifactId>
+                    <version>3.3.2</version>
+                    <configuration>
+                        <failOnMissingWebXml>false</failOnMissingWebXml>
+                    </configuration>
+                </plugin>
+
+                <plugin>
+                    <groupId>org.openapitools</groupId>
+                    <artifactId>openapi-generator-maven-plugin</artifactId>
+                    <version>7.8.0</version>
+                    <executions>
+                        <execution>
+                            <goals>
+                                <goal>generate</goal>
+                            </goals>
+                            <configuration>
+                                <inputSpec>${project.basedir}/src/main/resources/api.yml</inputSpec>
+                                <configOptions>
+                                    <sourceFolder>src/java/main</sourceFolder>
+                                </configOptions>
+                            </configuration>
+                        </execution>
+                    </executions>
+                </plugin>
+            </plugins>
+        </pluginManagement>
+    </build>
+</project>