Migrating to swagger3 / openapi

pom.xml

@@ -69,7 +69,7 @@
     <module>vpro-shared-monitoring</module>
     <module>vpro-shared-persistence</module>
     <module>vpro-shared-rs</module>
-    <module>vpro-shared-swagger</module>
+    <module>vpro-shared-swagger3</module>
 
     <module>vpro-shared-test</module>
     <module>vpro-shared-util</module>
@@ -81,6 +81,7 @@
     <module>vpro-shared-bom</module>
 
     <!--
+        <module>vpro-shared-swagger</module>
         <module>vpro-shared-client-resteasy3</module> - the other resteasy module as made compatibe with 3 too
          <module>vpro-shared-resteasy</module>
         <module>vpro-shared-camel</module>
@@ -285,10 +286,8 @@
     <hibernate.validator.version>6.2.5.Final</hibernate.validator.version>
 
     <ektorp.version>1.5.0</ektorp.version>
-    <!--
-    <swagger.version>2.0.0-rc2</swagger.version>
-    -->
-    <swagger.version>1.6.9</swagger.version>
+
+    <swagger.version>2.2.8</swagger.version>
     <lombok.version>1.18.24</lombok.version>
     <delombok.output>${project.build.directory}/delombok</delombok.output>
 
@@ -305,15 +304,20 @@
   <dependencyManagement>
     <dependencies>
       <dependency>
-        <groupId>io.swagger</groupId>
+        <groupId>io.swagger.core.v3</groupId>
         <artifactId>swagger-annotations</artifactId>
         <version>${swagger.version}</version>
       </dependency>
       <dependency>
-        <groupId>io.swagger</groupId>
-        <artifactId>swagger-jaxrs</artifactId>
+        <groupId>io.swagger.core.v3</groupId>
+        <artifactId>swagger-jaxrs2</artifactId>
         <version>${swagger.version}</version>
       </dependency>
+      <dependency>
+        <groupId>io.swagger.core.v3</groupId>
+        <artifactId>swagger-core</artifactId>
+         <version>${swagger.version}</version>
+      </dependency>
       <dependency>
         <groupId>nl.vpro.shared</groupId>
         <artifactId>vpro-shared-bom</artifactId>

vpro-shared-bom/pom.xml

@@ -159,9 +159,11 @@
         <artifactId>vpro-shared-xml</artifactId>
         <version>${project.version}</version>
       </dependency>
+
+
       <dependency>
         <groupId>nl.vpro.shared</groupId>
-        <artifactId>vpro-shared-swagger</artifactId>
+        <artifactId>vpro-shared-swagger3</artifactId>
         <version>${project.version}</version>
       </dependency>
 
@@ -233,6 +235,11 @@
         <artifactId>vpro-shared-resteasy</artifactId>
         <version>2.21.0</version>
       </dependency>
+      <dependency>
+        <groupId>nl.vpro.shared</groupId>
+        <artifactId>vpro-shared-swagger</artifactId>
+        <version>3.0.1</version>
+      </dependency>
     </dependencies>
   </dependencyManagement>
 

vpro-shared-swagger3/README.adoc

@@ -0,0 +1,5 @@
+= Swagger utilities
+
+This contains a few utility methods to deal with swagger.
+
+It has a dependency on a webjars for swagger frontend itself, and supplies a simply taglib to wire that into the actual HTML.

vpro-shared-swagger3/pom.xml

@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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>
+    <artifactId>vpro-shared-parent</artifactId>
+    <groupId>nl.vpro.shared</groupId>
+    <version>3.1-SNAPSHOT</version>
+  </parent>
+  <artifactId>vpro-shared-swagger3</artifactId>
+  <version>3.1-SNAPSHOT</version>
+
+  <properties>
+  </properties>
+
+  <dependencies>
+    <dependency>
+      <groupId>nl.vpro.shared</groupId>
+      <artifactId>vpro-shared-jackson2</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>nl.vpro.shared</groupId>
+      <artifactId>vpro-shared-web</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>io.swagger.core.v3</groupId>
+      <artifactId>swagger-core</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>io.swagger.core.v3</groupId>
+      <artifactId>swagger-jaxrs2</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.jboss.spec.javax.ws.rs</groupId>
+      <artifactId>jboss-jaxrs-api_2.1_spec</artifactId>
+      <version>2.0.1.Final</version>
+      <scope>provided</scope>
+    </dependency>
+    <dependency>
+      <groupId>jakarta.servlet</groupId>
+      <artifactId>jakarta.servlet-api</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.webjars</groupId>
+      <artifactId>swagger-ui</artifactId>
+      <version>4.9.1</version>
+    </dependency>
+    <dependency>
+      <groupId>org.projectlombok</groupId>
+      <artifactId>lombok</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>nl.vpro.shared</groupId>
+      <artifactId>vpro-shared-test</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.meeuw</groupId>
+      <artifactId>mihxil-json-grep</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-core</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>jakarta.annotation</groupId>
+      <artifactId>jakarta.annotation-api</artifactId>
+    </dependency>
+  </dependencies>
+</project>

vpro-shared-swagger3/src/main/java/nl/vpro/rs/media/WelcomeFilter.java

@@ -0,0 +1,35 @@
+package nl.vpro.rs.media;
+
+import lombok.extern.slf4j.Slf4j;
+
+import java.io.IOException;
+
+import javax.servlet.*;
+import javax.servlet.http.HttpServletResponse;
+
+/**
+ * MSE-4330. Er was gewoon een index.jsp die dat deed, maar dat werkt niet meer, omdat om een of andere reden het resteasy servlet er altijd tussen zat (terwijl niet eens gemapt)
+ * @author Michiel Meeuwissen
+ * @since 2.6
+ */
+@Slf4j
+public class WelcomeFilter implements Filter {
+
+
+
+    @Override
+    public void init(FilterConfig filterConfig) {
+
+    }
+
+    @Override
+    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException {
+        ((HttpServletResponse)servletResponse).sendRedirect("docs/api");
+
+    }
+
+    @Override
+    public void destroy() {
+
+    }
+}

vpro-shared-swagger3/src/main/java/nl/vpro/swagger/SwaggerApplication.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright (C) 2013 All rights reserved
+ * VPRO The Netherlands
+ */
+package nl.vpro.swagger;
+
+import lombok.extern.slf4j.Slf4j;
+
+import java.util.*;
+
+import javax.annotation.PostConstruct;
+import javax.ws.rs.ApplicationPath;
+import javax.ws.rs.core.Application;
+
+
+/**
+ * Static helper to expose a dummy JAX-RS Application. Swagger needs such an application to expose the API docs for
+ * the given endpoints.
+ *
+ * @author Roelof Jan Koekoek
+ * @since 2.0
+ */
+@Slf4j
+@ApplicationPath("")
+public class SwaggerApplication extends Application {
+    private static final Set<Object> singletons = new HashSet<>();
+
+    @Override
+    public Set<Class<?>> getClasses() {
+        Set<Class<?>> set = new HashSet<>();
+        return set;
+    }
+
+    @Override
+    public Set<Object> getSingletons() {
+        return singletons;
+    }
+
+    @PostConstruct
+    public void init() {
+        //inject();
+    }
+
+    /**
+     * Inject Swagger annotated JAX-RS api's you want to publish. Swagger only calls #getSingletons on the first
+     * API documentation request, so you must take care that your services get injected before an application accepts
+     * web requests. (Using @PostConstruct on your services is a viable solution)
+     *
+     * @param services
+     */
+    public static void inject(Object... services) {
+        singletons.addAll(Arrays.asList(services));
+    }
+
+
+
+}

vpro-shared-swagger3/src/main/java/nl/vpro/swagger/SwaggerFilter.java

@@ -0,0 +1,125 @@
+package nl.vpro.swagger;
+
+import lombok.extern.slf4j.Slf4j;
+
+import java.io.IOException;
+import java.io.OutputStream;
+
+import javax.servlet.*;
+import javax.servlet.http.*;
+import javax.ws.rs.core.MediaType;
+
+import org.meeuw.json.grep.Sed;
+import org.meeuw.json.grep.matching.*;
+
+import nl.vpro.web.HttpServletRequestUtils;
+
+/**
+ * This filter can be used to fill in 'api.basePath' using the request, so you don't have to configure it any more.
+ * @author Michiel Meeuwissen
+ * @since 0.21
+ */
+@Slf4j
+public class SwaggerFilter implements Filter {
+
+
+    @Override
+    public void init(FilterConfig filterConfig) {
+
+    }
+
+    @Override
+    public void doFilter(
+        ServletRequest request,
+        ServletResponse response, FilterChain chain) throws IOException, ServletException {
+        HttpServletRequest req = (HttpServletRequest) request;
+
+        if (! req.getPathInfo().endsWith(".json")) {
+            String accept = req.getHeader("accept");
+            if (accept != null) {
+                boolean json = false;
+                try {
+                    String[] mtypes = accept.split(";", 2)[0].split(",");
+                    for (String mtype : mtypes) {
+                        if (MediaType.valueOf(mtype).isCompatible(MediaType.APPLICATION_JSON_TYPE)) {
+                            json = true;
+                            break;
+                        }
+                    }
+                } catch (Exception e) {
+                    log.warn(e.getMessage());
+                }
+                if (!json) {
+                    log.debug("Not json");
+                    chain.doFilter(request, response);
+                    return;
+                }
+            }
+        }
+
+        PathMatcher matcher = getPathMatcher(req);
+
+        final ServletOutputStream servletOutputStream = response.getOutputStream();
+        final OutputStream out = transform(servletOutputStream, matcher);
+        HttpServletResponseWrapper wrapped = new HttpServletResponseWrapper((HttpServletResponse) response) {
+            @Override
+            public ServletOutputStream getOutputStream() {
+                return new ServletOutputStream() {
+                    @Override
+                    public boolean isReady() {
+                        return servletOutputStream.isReady();
+
+                    }
+
+                    @Override
+                    public void setWriteListener(WriteListener writeListener) {
+                        servletOutputStream.setWriteListener(writeListener);
+                    }
+
+                    @Override
+                    public void write(int b) throws IOException {
+                        out.write(b);
+
+                    }
+
+                    @Override
+                    public void write(byte[] b) throws IOException {
+                        out.write(b);
+                    }
+
+                    @Override
+                    public void write(byte[] b, int off, int len) throws IOException {
+                        out.write(b, off, len);
+                    }
+                };
+            }
+        };
+
+        chain.doFilter(request, wrapped);
+        out.close();
+
+    }
+
+
+    PathMatcher getPathMatcher(HttpServletRequest req) {
+        String host = req.getServerName() + HttpServletRequestUtils.getPortPostFixIfNeeded(req);
+        String basePath = req.getContextPath() + "/api";
+        return getPathMatcher(basePath, host);
+    }
+
+    PathMatcher getPathMatcher(String basePath, String host) {
+        return new PathMatcherOrChain(
+            new PathMatcherAndChain(
+                new SinglePathMatcher(new PreciseMatch("servers"), new ArrayEntryMatch(), new PreciseMatch("url")),
+                new ScalarEqualsMatcher("${api.basePath}", basePath)
+            )
+        );
+    }
+
+    public OutputStream transform(OutputStream to, PathMatcher pathMatcher) throws IOException {
+        return Sed.transform(to, pathMatcher);
+    }
+
+
+
+}