docs: #30 java Docs 작성

nhnacademy-be5-T3Team · May 13, 2024 · b159990 · b159990
1 parent 93837dd
commit b159990
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/src/main/java/com/t3t/frontserver/elastic/client/ElasticClient.java b/src/main/java/com/t3t/frontserver/elastic/client/ElasticClient.java
@@ -48,6 +48,13 @@ public interface ElasticClient {
                           @RequestParam int pageNo,
                           @PathVariable(value = "categoryId",required = false) BigDecimal categoryId,
                           @RequestParam(value = "sortBy", defaultValue = "_score", required = false) String sortBy);
+    /**
+     *
+     * elasticsearch 기반 실시간 자동완성
+     *
+     * @param prefix      text 검색어
+     * @return 서버의 데이터를 가지고 옴
+     */
     @GetMapping("/t3t/bookstore/autocomplete")
     ResponseEntity<BaseResponse<List<String>>> autocomplete(@RequestParam String prefix);
 }

diff --git a/src/main/java/com/t3t/frontserver/elastic/controller/AutocompleteController.java b/src/main/java/com/t3t/frontserver/elastic/controller/AutocompleteController.java
@@ -14,7 +14,13 @@
 @RequiredArgsConstructor
 public class AutocompleteController {
     private final ElasticClient elasticAdaptor;
-
+    /**
+     *
+     * elasticsearch 기반 실시간 자동완성
+     *
+     * @param prefix      text 검색어
+     * @return 페이지로 정보를 가지고 이동
+     */
 
     @GetMapping("/autocomplete")
     public ResponseEntity<BaseResponse<List<String>>> proxyAutocomplete(@RequestParam String prefix) {