feat: S3StroageController Swagger 입력

pjhcsols · Sep 19, 2024 · fe0e67d · fe0e67d
1 parent 6b50098
commit fe0e67d
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 14 deletions.
diff --git a/web3-credential-server/build/tmp/compileJava/previous-compilation-data.bin b/web3-credential-server/build/tmp/compileJava/previous-compilation-data.bin
diff --git a/web3-credential-server/src/main/java/web3/s3Storage/controller/S3StorageController.java b/web3-credential-server/src/main/java/web3/s3Storage/controller/S3StorageController.java
@@ -1,5 +1,7 @@
 package web3.s3Storage.controller;
 
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
 import jakarta.persistence.EntityNotFoundException;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
@@ -28,11 +30,17 @@ public S3StorageController(S3StorageService s3StorageService, WalletService wall
         this.walletService = walletService;
     }
 
+    @Operation(summary = "pdf 업로드",description = "s3 스토리지에 pdf 파일을 업로드 합니다.")
     @PostMapping("/upload-pdf")
-    public ResponseEntity<String> uploadPdf(@RequestParam("file") MultipartFile file,
-                                            @RequestParam("walletId") Long walletId,
-                                            @RequestParam String pdfInfo,
-                                            @RequestParam String pdfKey) {
+    public ResponseEntity<String> uploadPdf(
+            @Parameter(description = "업로드할 pdf 파일",required = true)
+            @RequestParam("file") MultipartFile file,
+            @Parameter(description = "사용자 지갑ID",required = true)
+            @RequestParam("walletId") Long walletId,
+            @Parameter(description = "pdf 정보",required = true)
+            @RequestParam String pdfInfo,
+            @Parameter(description = "pdf 키값",required = true)
+            @RequestParam String pdfKey) {
         Wallet wallet = walletService.getWalletById(walletId).orElseThrow(()-> new EntityNotFoundException("Wallet does not exist"));
         try {
             String pdfUrl = s3StorageService.uploadPdf(file, wallet,pdfInfo,pdfKey);
@@ -44,23 +52,32 @@ public ResponseEntity<String> uploadPdf(@RequestParam("file") MultipartFile file
     }
 
 
+    @Operation(summary = "pdf 업로드",description = "s3 스토리지에 pdf 파일을 업로드 합니다.")
     @DeleteMapping("/delete-pdf")
-    public ResponseEntity<Void> deletePdf(@RequestBody DeletePdfRequest request) {
+    public ResponseEntity<Void> deletePdf(
+            @Parameter(description = "지울 pdf 파일 경로 관련 Dto",required = true)
+            @RequestBody DeletePdfRequest request) {
         String urlToDelete = request.getUrlToDelete();
         System.out.println("urlToDelete = " + urlToDelete);
         s3StorageService.deletePdf(urlToDelete);
         return ResponseEntity.noContent().build();
     }
 
+    @Operation(summary = "인증서 리스트 얻기",description = "개인의 인증서들을 모두 가져옵니다. 형식 : (페이지 - 설명)")
     @GetMapping("/certs")
-    public ResponseEntity<HashMap<String,String>> getCertList(@RequestParam("pdfUrl") String pdfUrl) {
+    public ResponseEntity<HashMap<String,String>> getCertList(
+            @Parameter(description = "pdf 파일 경로",required = true)
+            @RequestParam("pdfUrl") String pdfUrl) {
         HashMap<String, String> certList = s3StorageService.getCertList(pdfUrl);
         return ResponseEntity.ok().body(certList);
 
     }
 
+    @Operation(summary = "인증서 리스트 얻기 - pdf 형식",description = "개인의 인증서들을 pdf의 형식으로 모두 가져옵니다.")
     @GetMapping("/get-pdf")
-    public ResponseEntity<byte[]> getPdf(@RequestParam("pdfUrl") String pdfUrl) {
+    public ResponseEntity<byte[]> getPdf(
+            @Parameter(description = "pdf 파일 경로",required = true)
+            @RequestParam("pdfUrl") String pdfUrl) {
         try {
             System.out.println("pdfUrl = " + pdfUrl);
             byte[] pdfData = s3StorageService.getPdf(pdfUrl).readAllBytes();
@@ -71,10 +88,15 @@ public ResponseEntity<byte[]> getPdf(@RequestParam("pdfUrl") String pdfUrl) {
         }
     }
 
+    @Operation(summary = "pdf 대체하기",description = "원하는 페이지를 원하는 pdf로 대체합니다.")
     @PostMapping("/replace-pdf")
-    public ResponseEntity<String> replacePdf(@RequestParam("file") MultipartFile file,
-                                             @RequestParam("page") int page,
-                                             @RequestParam("walletId") Long walletId) {
+    public ResponseEntity<String> replacePdf(
+            @Parameter(description = "pdf 파일",required = true)
+            @RequestParam("file") MultipartFile file,
+            @Parameter(description = "페이지 번호",required = true)
+            @RequestParam("page") int page,
+            @Parameter(description = "사용자 지갑ID",required = true)
+            @RequestParam("walletId") Long walletId) {
         try {
             System.out.println("file = " + file);
             Wallet wallet = walletService.getWalletById(walletId).orElseThrow(()-> new EntityNotFoundException("Wallet does not exist"));
@@ -86,16 +108,24 @@ public ResponseEntity<String> replacePdf(@RequestParam("file") MultipartFile fil
         }
     }
 
+    @Operation(summary = "메타데이터 얻기",description = "사용자의 모든 메타데이터의 정보들을 가져옵니다.")
     @GetMapping("/get-metadata")
-    public ResponseEntity<String> getMetadata(@RequestParam String pdfUrl,
-                                              @RequestParam int page) {
+    public ResponseEntity<String> getMetadata(
+            @Parameter(description = "pdf 파일 경로",required = true)
+            @RequestParam String pdfUrl,
+            @Parameter(description = "페이지 번호",required = true)
+            @RequestParam int page) {
         String metadata = s3StorageService.getMetadataForPage(pdfUrl, page);
         return ResponseEntity.ok().body(metadata);
     }
 
+    @Operation(summary = "pdf key값 얻기",description = "사용자의 pdf에서 원하는 페이지의 key값을 가져옵니다.")
     @GetMapping("/get-pdfkey")
-    public ResponseEntity<String> getPdfKey(@RequestParam String pdfUrl,
-                                              @RequestParam int page) {
+    public ResponseEntity<String> getPdfKey(
+            @Parameter(description = "pdf 파일 경로",required = true)
+            @RequestParam String pdfUrl,
+            @Parameter(description = "페이지 번호",required = true)
+            @RequestParam int page) {
         String metadata = s3StorageService.getPdfKeyForPage(pdfUrl, page);
         return ResponseEntity.ok().body(metadata);
     }