Migrate from springfox to springdoc-openapi

Resolves #12.

Author: iay

pom.xml

@@ -29,8 +29,8 @@
         <java-support.version>8.2.1</java-support.version>
         <spring-extensions.version>6.1.3</spring-extensions.version>
 
-        <springfox-version>2.9.2</springfox-version>
         <spring.boot.version>2.4.13</spring.boot.version>
+        <springdoc.version>1.6.3</springdoc.version>
     </properties>
 
     <dependencies>
@@ -79,28 +79,6 @@
             <artifactId>spring-boot-autoconfigure</artifactId>
         </dependency>
 
-        <!--SpringFox dependencies -->
-        <dependency>
-            <groupId>io.springfox</groupId>
-            <artifactId>springfox-core</artifactId>
-            <version>${springfox-version}</version>
-        </dependency>
-        <dependency>
-            <groupId>io.springfox</groupId>
-            <artifactId>springfox-swagger2</artifactId>
-            <version>${springfox-version}</version>
-        </dependency>
-        <dependency>
-            <groupId>io.springfox</groupId>
-            <artifactId>springfox-spi</artifactId>
-            <version>${springfox-version}</version>
-        </dependency>
-        <dependency>
-            <groupId>io.springfox</groupId>
-            <artifactId>springfox-spring-web</artifactId>
-            <version>${springfox-version}</version>
-        </dependency>
-
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-annotations</artifactId>
@@ -111,10 +89,17 @@
         </dependency>
 
         <dependency>
-            <groupId>io.swagger</groupId>
+            <groupId>io.swagger.core.v3</groupId>
             <artifactId>swagger-annotations</artifactId>
-            <version>1.6.3</version>
+            <version>2.1.12</version>
         </dependency>
+
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-ui</artifactId>
+            <version>${springdoc.version}</version>
+        </dependency>
+
         <dependency>
             <groupId>jakarta.xml.bind</groupId>
             <artifactId>jakarta.xml.bind-api</artifactId>
@@ -157,13 +142,6 @@
             <scope>runtime</scope>
         </dependency>
 
-        <dependency>
-            <groupId>io.springfox</groupId>
-            <artifactId>springfox-swagger-ui</artifactId>
-            <version>${springfox-version}</version>
-            <scope>runtime</scope>
-        </dependency>
-
         <dependency>
             <groupId>ch.qos.logback</groupId>
             <artifactId>logback-classic</artifactId>
@@ -259,9 +237,9 @@
 
             <!-- Generate code for the API using swagger-codegen. -->
             <plugin>
-                <groupId>io.swagger</groupId>
+                <groupId>io.swagger.codegen.v3</groupId>
                 <artifactId>swagger-codegen-maven-plugin</artifactId>
-                <version>2.4.24</version>
+                <version>3.0.30</version>
                 <executions>
                     <execution>
                         <goals>
@@ -324,9 +302,9 @@
                             <pluginExecutions>
                                 <pluginExecution>
                                     <pluginExecutionFilter>
-                                        <groupId>io.swagger</groupId>
+                                        <groupId>io.swagger.codegen.v3</groupId>
                                         <artifactId>swagger-codegen-maven-plugin</artifactId>
-                                        <versionRange>[2.3.1,)</versionRange>
+                                        <versionRange>[3.0.0,)</versionRange>
                                         <goals>
                                             <goal>generate</goal>
                                         </goals>

src/main/java/uk/org/iay/md/validator/ValidatorApplication.java

@@ -0,0 +1,56 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package uk.org.iay.md.validator;
+
+import javax.annotation.Nonnull;
+
+import org.springframework.boot.CommandLineRunner;
+import org.springframework.boot.ExitCodeGenerator;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+/**
+ * Main application class.
+ */
+@SpringBootApplication
+public class ValidatorApplication implements CommandLineRunner {
+
+    @Override
+    public void run(final String... arg0) throws Exception {
+        if (arg0.length > 0 && arg0[0].equals("exitcode")) {
+            throw new ExitException();
+        }
+    }
+
+    /**
+     * Command-line entry point.
+     *
+     * @param args command-line arguments
+     * @throws Exception if something goes wrong
+     */
+    public static void main(@Nonnull final String[] args) throws Exception {
+        new SpringApplication(ValidatorApplication.class).run(args);
+    }
+
+    class ExitException extends RuntimeException implements ExitCodeGenerator {
+        private static final long serialVersionUID = 1L;
+
+        @Override
+        public int getExitCode() {
+            return 10;
+        }
+
+    }
+
+}

src/main/java/uk/org/iay/md/validator/api/ApiException.java

@@ -23,7 +23,7 @@
 /**
  * Exception class for use within the API.
  */
-public class ApiException extends Exception {
+public class ApiException extends RuntimeException {
 
     /** Serial version UID. */
     private static final long serialVersionUID = -5046975083822313941L;

src/main/java/uk/org/iay/md/validator/api/ValidatorsApi.java

@@ -35,7 +35,6 @@
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 
-import io.swagger.annotations.ApiParam;
 import net.shibboleth.metadata.ErrorStatus;
 import net.shibboleth.metadata.InfoStatus;
 import net.shibboleth.metadata.Item;
@@ -118,11 +117,8 @@ private Status convertStatus(final StatusMetadata stat) {
 
     @Override
     public ResponseEntity<List<Status>> validate(
-            @ApiParam(value = "An identifier for the validation to be performed.", required = true)
-                @PathVariable("validator_id")
-                final String validatorId,
-            @ApiParam(value = "The metadata to be validated.", required = true) @Valid @RequestBody
-                final String metadata) throws ApiException {
+                @PathVariable("validator_id") final String validatorId,
+                @Valid @RequestBody final String metadata) {
 
         // Fetch the required validator.
         final ValidatorCollection.Entry entry = validatorCollection.getEntry(validatorId);

src/main/java/uk/org/iay/md/validator/api/ValidatorsApiController.java

@@ -1,5 +1,3 @@
-springfox.documentation.swagger.v2.path=/api-docs
-
 server.port=8080
 spring.jackson.date-format=uk.org.iay.md.validator.RFC3339DateFormat
 spring.jackson.serialization.WRITE_DATES_AS_TIMESTAMPS=false

src/main/resources/application.properties

@@ -17,12 +17,14 @@ README.md
 **/ValidatorsApiController.java
 
 #
-# Turns out we need to make changes to the API classes as well, to
-# allow for exceptions.
+# In turn, that means we don't need to generate the exception classes.
 #
-**/ValidatorsApi.java
+**/*Exception.java
 
 #
-# In turn, that means we don't need to generate the exception classes.
+# Strip out the classes that bridge to springfox, now that we use
+# springdoc-openapi-ui.
 #
-**/*Exception.java
+**/Swagger2SpringBoot.java
+**/SwaggerDocumentationConfig.java
+**/SwaggerUIConfiguration.java