chore: Rest Docs 샘플 - 추후 삭제 예정인 부분들 표기

Kernel360 · Jan 19, 2024 · bf891da · bf891da
1 parent 8ec970a
commit bf891da
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 1 deletion.
diff --git a/module-api/src/docs/asciidoc/index.adoc b/module-api/src/docs/asciidoc/index.adoc
@@ -7,4 +7,5 @@
 :sectlinks:
 
 include::overview.adoc[]
-include::sample-api.adoc[]
+include::sample-api.adoc[]
+// !!! 위 라인 1줄은 추후 삭제 예정입니다 !!!
diff --git a/module-api/src/docs/asciidoc/sample-api.adoc b/module-api/src/docs/asciidoc/sample-api.adoc
@@ -1,3 +1,4 @@
+// !!! 삭제 예정 파일입니다 !!!
 == 샘플 API
 
 // [[]] 안에는 a 태그 이름 들어갑니다 (http://localhost:8080/docs/index#공통코드-조회)

diff --git a/module-api/src/main/java/com/kernel360/commoncode/controller/CommonCodeController.java b/module-api/src/main/java/com/kernel360/commoncode/controller/CommonCodeController.java
@@ -32,6 +32,7 @@ public List<CommonCodeDto> getCommonCode (@PathVariable String codeName){
         return commonCodeService.getCodes(codeName);
     }
 
+    // !!! 아래 메서드는 추후 삭제 예정입니다 !!!
     @GetMapping("/test/{codeName}")
     public ResponseEntity<ApiResponse> getCommonCode_1 (@PathVariable String codeName){
         List<CommonCodeDto> codes = commonCodeService.getCodes(codeName);

diff --git a/...i/src/test/java/com/kernel360/commoncode/controller/CommonCodeControllerRestDocsTest.java b/...i/src/test/java/com/kernel360/commoncode/controller/CommonCodeControllerRestDocsTest.java
@@ -19,6 +19,7 @@
 import static org.springframework.restdocs.request.RequestDocumentation.*;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
 
+// !!! 삭제 예정 파일입니다 !!!
 class CommonCodeControllerRestDocsTest extends ControllerTest {
 
     @Test