Added swagger documentation

veraPDF · Mar 1, 2021 · 81c5a86 · 81c5a86
1 parent 828f4df
commit 81c5a86
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 3 deletions.
diff --git a/job-service/server/pom.xml b/job-service/server/pom.xml
@@ -13,6 +13,7 @@
 
     <properties>
         <java.version>11</java.version>
+        <springdoc-ui.version>1.5.4</springdoc-ui.version>
     </properties>
 
     <dependencies>
@@ -53,6 +54,11 @@
             <artifactId>flyway-core</artifactId>
             <scope>runtime</scope>
         </dependency>
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-ui</artifactId>
+            <version>${springdoc-ui.version}</version>
+        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>

diff --git a/job-service/server/src/main/resources/application.yml b/job-service/server/src/main/resources/application.yml
@@ -41,3 +41,12 @@ verapdf:
       listening-queue:
         name: ${amqp.server.listening.queue.name}
         max-size: ${amqp.server.listening.queue.max.size}
+
+springdoc:
+  api-docs:
+    path: /jobs/docs
+    enabled: true
+  swagger-ui:
+    path: /jobs/swagger
+    operations-sorter: method
+    enabled: true
diff --git a/local-storage-service/server/pom.xml b/local-storage-service/server/pom.xml
@@ -16,6 +16,7 @@
 
     <properties>
         <java.version>11</java.version>
+        <springdoc-ui.version>1.5.4</springdoc-ui.version>
     </properties>
 
     <dependencies>
@@ -51,6 +52,11 @@
             <artifactId>flyway-core</artifactId>
             <scope>runtime</scope>
         </dependency>
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-ui</artifactId>
+            <version>${springdoc-ui.version}</version>
+        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>

diff --git a/...rc/main/java/org/verapdf/webapp/localstorageservice/server/controller/FileController.java b/...rc/main/java/org/verapdf/webapp/localstorageservice/server/controller/FileController.java
@@ -30,13 +30,14 @@ public FileController(StoredFileService storedFileService) {
 		this.storedFileService = storedFileService;
 	}
 
-	@PostMapping
+	@PostMapping(consumes = {MediaType.MULTIPART_FORM_DATA_VALUE, MediaType.APPLICATION_JSON_VALUE})
 	public ResponseEntity<StoredFileDTO> uploadFile(@RequestPart("file") MultipartFile file,
-	                                @RequestPart(required = false) @Pattern(regexp = "^[\\da-fA-F]{32}$") String contentMD5) throws VeraPDFBackendException {
+	                                                @RequestPart(required = false)
+	                                                @Pattern(regexp = "^[\\da-fA-F]{32}$") String contentMD5) throws VeraPDFBackendException {
 		StoredFileDTO storedFileDTO = storedFileService.saveStoredFile(file, contentMD5);
 		URI uri = MvcUriComponentsBuilder
 				.fromMethodName(FileController.class,
-						"getFileData", storedFileDTO.getId())
+				                "getFileData", storedFileDTO.getId())
 				.build()
 				.encode()
 				.toUri();

diff --git a/local-storage-service/server/src/main/resources/application.yml b/local-storage-service/server/src/main/resources/application.yml
@@ -30,3 +30,12 @@ verapdf:
   files:
     min-space-threshold: ${localstorage.disk.min.space.threshold:5GB}
     base-dir: /opt/verapdf/localstorageservice/files
+
+springdoc:
+  api-docs:
+    path: /files/docs
+    enabled: true
+  swagger-ui:
+    path: /files/swagger
+    operations-sorter: method
+    enabled: true