feat: try to solve some springdoc issue with paths + schema convertes

rocketbase-io · Aug 28, 2024 · 8fc801b · 8fc801b
1 parent 86ac947
commit 8fc801b
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 3 deletions.
diff --git a/commons-rest-openapi/src/test/java/io/rocketbase/commons/openapi/GenerateClientTest.java b/commons-rest-openapi/src/test/java/io/rocketbase/commons/openapi/GenerateClientTest.java
@@ -31,6 +31,13 @@ public void downloadZip() throws Exception {
         log.info("downloaded: {}", destination.getAbsolutePath());
     }
 
+    @Test
+    public void downloadOpenApiYaml() throws Exception {
+        File destination = new File("target/api-docs.yaml");
+        download(new URL(baseUrl + "/v3/api-docs.yaml"), destination);
+        log.info("downloaded: {}", destination.getAbsolutePath());
+    }
+
     private static void download(URL url, File file) throws IOException {
         ReadableByteChannel rbc = Channels.newChannel(url.openStream());
         FileOutputStream fos = new FileOutputStream(file);

diff --git a/commons-rest-openapi/src/test/java/io/rocketbase/commons/openapi/sample/dto/Tile.java b/commons-rest-openapi/src/test/java/io/rocketbase/commons/openapi/sample/dto/Tile.java
@@ -1,5 +1,6 @@
 package io.rocketbase.commons.openapi.sample.dto;
 
+import io.hypersistence.tsid.TSID;
 import lombok.*;
 
 import java.io.Serializable;
@@ -12,7 +13,7 @@
 @Data
 public class Tile implements Serializable {
 
-    private String id;
+    private TSID id;
 
     private TileType type;
 

diff --git a/...ons-rest-openapi/src/test/java/io/rocketbase/commons/openapi/sample/resource/TileApi.java b/...ons-rest-openapi/src/test/java/io/rocketbase/commons/openapi/sample/resource/TileApi.java
@@ -1,5 +1,6 @@
 package io.rocketbase.commons.openapi.sample.resource;
 
+import io.hypersistence.tsid.TSID;
 import io.rocketbase.commons.dto.PageableResult;
 import io.rocketbase.commons.generator.InfiniteHook;
 import io.rocketbase.commons.generator.QueryHook;
@@ -54,5 +55,5 @@ ResponseEntity<PageableResult<Tile>> loadTiles(@ParameterObject
             consumes = MimeTypeUtils.ALL_VALUE
     )
     Tile get(@Parameter(description = "id of tile", required = true)
-             @PathVariable("id") String id);
+             @PathVariable("id") TSID id);
 }
diff --git a/...t-openapi/src/test/java/io/rocketbase/commons/openapi/sample/resource/TileController.java b/...t-openapi/src/test/java/io/rocketbase/commons/openapi/sample/resource/TileController.java
@@ -1,5 +1,6 @@
 package io.rocketbase.commons.openapi.sample.resource;
 
+import io.hypersistence.tsid.TSID;
 import io.rocketbase.commons.dto.PageableResult;
 import io.rocketbase.commons.openapi.sample.dto.Tile;
 import io.rocketbase.commons.openapi.sample.dto.UserPreference;
@@ -19,7 +20,7 @@ public ResponseEntity<PageableResult<Tile>> loadTiles(Pageable pageable, Optiona
     }
 
     @Override
-    public Tile get(String id) {
+    public Tile get(TSID id) {
         return null;
     }
 }
diff --git a/...est-tsid/src/main/java/io/rocketbase/commons/config/CommonsRestTsidAutoConfiguration.java b/...est-tsid/src/main/java/io/rocketbase/commons/config/CommonsRestTsidAutoConfiguration.java
@@ -4,13 +4,15 @@
 import io.hypersistence.tsid.TSID;
 import io.rocketbase.commons.controller.exceptionhandler.TsidDecodeExceptionHandler;
 import io.rocketbase.commons.exception.TsidDecodeException;
+import io.rocketbase.commons.tsid.TsidConverter;
 import io.rocketbase.commons.tsid.TsidModule;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.core.convert.converter.Converter;
 import org.springframework.format.Formatter;
 import org.springframework.util.StringUtils;
 import org.springframework.web.bind.WebDataBinder;
@@ -36,6 +38,11 @@ public Module tsidModule() {
         return new TsidModule();
     }
 
+    @Bean
+    public Converter tsidConverter() {
+        return new TsidConverter();
+    }
+
     @RestControllerAdvice
     public static class Advice {
 

diff --git a/commons-rest-tsid/src/main/java/io/rocketbase/commons/tsid/TsidConverter.java b/commons-rest-tsid/src/main/java/io/rocketbase/commons/tsid/TsidConverter.java
@@ -0,0 +1,14 @@
+package io.rocketbase.commons.tsid;
+
+import io.hypersistence.tsid.TSID;
+import org.springframework.core.convert.converter.Converter;
+import org.springframework.lang.Nullable;
+
+public class TsidConverter implements Converter<String, TSID> {
+
+    @Nullable
+    @Override
+    public TSID convert(String value) {
+        return TSID.isValid(value) ? TSID.from(value) : null;
+    }
+}