Open api publish (#3279)

Author: Josh

.github/workflows/publish-openapi.yaml

@@ -0,0 +1,14 @@
+name: Publish OpenAPI specs
+on:
+  push:
+    branches:
+      - "master"
+
+jobs:
+  publish-openapi:
+    uses: hmcts/workflow-publish-openapi-spec/.github/workflows/publish-openapi.yml@v1
+    secrets:
+      SWAGGER_PUBLISHER_API_TOKEN: ${{ secrets.SWAGGER_PUBLISHER_API_TOKEN }}
+    with:
+      test_to_run: 'uk.gov.hmcts.reform.bulkscanprocessor.config.SwaggerPublisher'
+      java_version: 17

src/integrationTest/java/uk/gov/hmcts/reform/bulkscanprocessor/config/SwaggerPublisher.java

@@ -0,0 +1,42 @@
+package uk.gov.hmcts.reform.bulkscanprocessor.config;
+
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
+import org.springframework.test.web.servlet.MockMvc;
+
+import java.io.OutputStream;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+/**
+ * Built-in feature which saves service's swagger specs in temporary directory.
+ * HMCTS GitHub workflow automatically runs on master and publishes to cnp-api-docs.
+ */
+@AutoConfigureMockMvc
+@IntegrationTest
+class SwaggerPublisher {
+
+    @Autowired
+    private MockMvc mvc;
+
+    @DisplayName("Generate swagger documentation")
+    @Test
+    @SuppressWarnings("PMD.JUnitTestsShouldIncludeAssert")
+    void generateDocs() throws Exception {
+        byte[] specs = mvc.perform(get("/v3/api-docs"))
+            .andExpect(status().isOk())
+            .andReturn()
+            .getResponse()
+            .getContentAsByteArray();
+
+        try (OutputStream outputStream = Files.newOutputStream(Paths.get("/tmp/openapi-specs.json"))) {
+            outputStream.write(specs);
+        }
+
+    }
+}

src/main/resources/application.yaml

@@ -269,3 +269,7 @@ jms:
 launchdarkly:
   sdk-key: ${LAUNCH_DARKLY_SDK_KEY:XXXXX}
   offline-mode: ${LAUNCH_DARKLY_OFFLINE_MODE:false}
+
+springdoc:
+  packagesToScan: uk.gov.hmcts.reform.bulkscanprocessor.controllers
+  pathsToMatch: /**