temp rest service and sagger set up

Author: joe-mccarthy

pom.xml

@@ -14,22 +14,11 @@
 	<version>0.0.1-SNAPSHOT</version>
 	<name>metmesh</name>
 	<description>Demo project for Spring Boot</description>
-	<url/>
-	<licenses>
-		<license/>
-	</licenses>
-	<developers>
-		<developer/>
-	</developers>
-	<scm>
-		<connection/>
-		<developerConnection/>
-		<tag/>
-		<url/>
-	</scm>
+	
 	<properties>
-		<java.version>21</java.version>
+		<java.version>21</java.version>	
 	</properties>
+	
 	<dependencies>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
@@ -45,16 +34,27 @@
 		<dependency>
 			<groupId>org.projectlombok</groupId>
 			<artifactId>lombok</artifactId>
-			<optional>true</optional>
 		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-test</artifactId>
 			<scope>test</scope>
 		</dependency>
+<dependency>
+    <groupId>org.springdoc</groupId>
+    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+    <version>2.0.3</version>
+</dependency>
+
+<dependency>
+    <groupId>io.swagger.core.v3</groupId>
+    <artifactId>swagger-annotations</artifactId>
+    <version>2.2.16</version>
+</dependency>
 	</dependencies>
 
 	<build>
+		
 		<plugins>
 			<plugin>
 				<groupId>org.springframework.boot</groupId>
@@ -68,10 +68,27 @@
 					</excludes>
 				</configuration>
 			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-compiler-plugin</artifactId>
+				<version>3.8.1</version>
+				<configuration>					
+					<release>21</release>
+					<annotationProcessorPaths>
+						<path>
+							<groupId>org.projectlombok</groupId>
+							<artifactId>lombok</artifactId>
+							<version>${lombok.version}</version>
+						</path>
+					</annotationProcessorPaths>
+				</configuration>
+			</plugin>
 		</plugins>
 
 		<finalName>metmesh</finalName>
 
 	</build>
 
+
+	
 </project>

src/main/java/com/github/joe_mccarthy/metmesh/MetmeshApplication.java renamed to src/main/java/com/github/joemccarthy/metmesh/MetmeshApplication.java

@@ -1,4 +1,4 @@
-package com.github.joe_mccarthy.metmesh;
+package com.github.joemccarthy.metmesh;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;

src/main/java/com/github/joemccarthy/metmesh/configuration/ApplicationConfiguration.java

@@ -0,0 +1,8 @@
+package com.github.joemccarthy.metmesh.configuration;
+
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class ApplicationConfiguration {
+    
+}

src/main/java/com/github/joemccarthy/metmesh/configuration/SchedulerConfiguration.java

@@ -0,0 +1,10 @@
+package com.github.joemccarthy.metmesh.configuration;
+
+import org.springframework.context.annotation.Configuration;
+import org.springframework.scheduling.annotation.EnableScheduling;
+
+@Configuration
+@EnableScheduling
+public class SchedulerConfiguration {
+    
+}

src/main/java/com/github/joemccarthy/metmesh/configuration/SwaggerConfiguration.java

@@ -0,0 +1,17 @@
+package com.github.joemccarthy.metmesh.configuration;
+
+import io.swagger.v3.oas.annotations.OpenAPIDefinition;
+import  io.swagger.v3.oas.annotations.info.Info;
+import  io.swagger.v3.oas.annotations.info.License;
+
+import  io.swagger.v3.oas.annotations.info.Contact;
+
+@OpenAPIDefinition(
+    info = @Info(title = SwaggerConstants.API_TITLE, 
+    version = SwaggerConstants.API_VERSION, description = SwaggerConstants.API_DESCRIPTION,
+    license = @License(name = SwaggerConstants.SwaggerLicence.NAME, url = SwaggerConstants.SwaggerLicence.URL), 
+    contact = @Contact(name = SwaggerConstants.SwaggerContact.NAME, email = SwaggerConstants.SwaggerContact.EMAIL, 
+    url = SwaggerConstants.SwaggerContact.URL)))
+public class SwaggerConfiguration {
+    
+}

src/main/java/com/github/joemccarthy/metmesh/configuration/SwaggerConstants.java

@@ -0,0 +1,19 @@
+package com.github.joemccarthy.metmesh.configuration;
+
+public class SwaggerConstants {
+    
+    public final static String API_TITLE = "MetMesh API";
+    public final static String API_VERSION = "1.0.0";
+    public final static String API_DESCRIPTION = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum odio dui, accumsan et dictum sed, mollis vel augue. Integer at mauris sem. Nam non faucibus orci. Nunc vel porttitor arcu. Aliquam sagittis a dolor id tempus. Donec eget augue justo. Duis bibendum magna gravida erat luctus, nec malesuada nulla cursus. Nulla egestas convallis odio, vel pulvinar augue pretium sed.";
+
+    public class SwaggerLicence {
+        public final static String NAME = "LGPL-2.1-1";
+        public final static String URL = "https://opensource.org/license/lgpl-2-1";
+    }
+
+    public class SwaggerContact {
+        public final static String NAME = "Random Person";
+        public final static String EMAIL = "[email protected]";
+        public final static String URL = "https://example.com";
+    }
+}

src/main/java/com/github/joemccarthy/metmesh/services/server/ServerRestController.java

@@ -0,0 +1,25 @@
+package com.github.joemccarthy.metmesh.services.server;
+
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import com.github.joemccarthy.metmesh.services.server.delegate.ServerDelegate;
+import com.github.joemccarthy.metmesh.services.server.dto.ServerDTO;
+
+
+import lombok.RequiredArgsConstructor;
+
+
+@RestController
+@RequiredArgsConstructor
+public class ServerRestController {
+    
+    private final ServerDelegate serverDelegate;
+
+    @GetMapping(path = "/api/v1/server")
+    public ResponseEntity<ServerDTO> getMethodName() {
+        return ResponseEntity.ok(ServerDTO.builder().name(serverDelegate.getMethodName()).build());
+    }
+    
+}

src/main/java/com/github/joemccarthy/metmesh/services/server/delegate/ServerDelegate.java

@@ -0,0 +1,11 @@
+package com.github.joemccarthy.metmesh.services.server.delegate;
+
+import org.springframework.stereotype.Component;
+
+@Component
+public class ServerDelegate {
+    
+    public String getMethodName() {
+        return "getMethodName";
+    }
+}

src/main/java/com/github/joemccarthy/metmesh/services/server/dto/ServerDTO.java

@@ -0,0 +1,15 @@
+package com.github.joemccarthy.metmesh.services.server.dto;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Builder
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class ServerDTO {
+
+    private String name;
+}

src/main/resources/application.yml

@@ -3,4 +3,4 @@ server:
 
 spring:
   application:
-    name: metmesh
+    name: metmesh

src/test/java/com/github/joe_mccarthy/metmesh/MetmeshApplicationTests.java renamed to src/test/java/com/github/joemccarthy/metmesh/MetmeshApplicationTests.java

@@ -1,4 +1,4 @@
-package com.github.joe_mccarthy.metmesh;
+package com.github.joemccarthy.metmesh;
 
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.test.context.SpringBootTest;