feat: 경로, 예시, 포맷 등 추가

korECM · Jul 24, 2022 · b10a022 · b10a022
1 parent 43a05ef
commit b10a022
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 14 deletions.
diff --git a/src/test/kotlin/zip/cafe/api/FeedControllerTest.kt b/src/test/kotlin/zip/cafe/api/FeedControllerTest.kt
@@ -101,7 +101,7 @@ class FeedControllerTest : WebMvcTestSpec() {
                         "review.likeCount" type NUMBER means "리뷰 좋아요 개수" example "5L",
                         "review.keyword" type ARRAY means "리뷰에 있는 키워드 목록",
                         "review.commentCount" type NUMBER means "리뷰 댓글 개수" example "3L",
-                        "review.createdAt" type STRING means "리뷰가 작성된 시간" formattedAs "yyyy-MM-dd HH:mm:ss" example "2022-02-12 13:52:12",
+                        "review.createdAt" type DATETIME means "리뷰가 작성된 시간" formattedAs "yyyy-MM-dd HH:mm:ss" example "2022-02-12 13:52:12",
                     )
                 )
             )

diff --git a/src/test/kotlin/zip/cafe/api/utils/restdocs/DocsFieldType.kt b/src/test/kotlin/zip/cafe/api/utils/restdocs/DocsFieldType.kt
@@ -9,6 +9,7 @@ sealed class DocsFieldType(
 
 object ARRAY : DocsFieldType(JsonFieldType.ARRAY)
 object STRING : DocsFieldType(JsonFieldType.STRING)
+object DATETIME : DocsFieldType(JsonFieldType.STRING)
 object NULL : DocsFieldType(JsonFieldType.NULL)
 object NUMBER : DocsFieldType(JsonFieldType.NUMBER)
 object BOOLEAN : DocsFieldType(JsonFieldType.BOOLEAN)

diff --git a/src/test/resources/org/springframework/restdocs/templates/path-parameters.snippet b/src/test/resources/org/springframework/restdocs/templates/path-parameters.snippet
@@ -0,0 +1,13 @@
+.+{{path}}+
+    |===
+    |파라미터 이름|설명|필수 여부|기본값|형식
+
+{{#parameters}}
+    |{{#tableCellContent}}`+{{name}}+`{{/tableCellContent}}
+    |{{#tableCellContent}}{{^optional}}`true`{{/optional}}{{/tableCellContent}}
+    |{{#tableCellContent}}{{description}}{{/tableCellContent}}
+    |{{#tableCellContent}}{{#example}}`{{.}}`{{/example}}{{/tableCellContent}}
+    |{{#tableCellContent}}{{format}}{{/tableCellContent}}
+
+{{/parameters}}
+    |===
diff --git a/src/test/resources/org/springframework/restdocs/templates/request-fields.snippet b/src/test/resources/org/springframework/restdocs/templates/request-fields.snippet
@@ -1,11 +1,12 @@
 |===
-|필드명|타입|필수 여부|설명|예시
+    |필드명|타입|필수 여부|설명|예시|형식
 
 {{#fields}}
-|{{#tableCellContent}}`{{path}}`{{/tableCellContent}}
-|{{#tableCellContent}}`{{type}}`{{/tableCellContent}}
-|{{#tableCellContent}}{{^optional}}`true`{{/optional}}{{/tableCellContent}}
-|{{#tableCellContent}}{{description}}{{/tableCellContent}}
-|{{#tableCellContent}}{{#example}}`{{.}}`{{/example}}{{/tableCellContent}}
+    |{{#tableCellContent}}`{{path}}`{{/tableCellContent}}
+    |{{#tableCellContent}}`{{type}}`{{/tableCellContent}}
+    |{{#tableCellContent}}{{^optional}}`true`{{/optional}}{{/tableCellContent}}
+    |{{#tableCellContent}}{{description}}{{/tableCellContent}}
+    |{{#tableCellContent}}{{#example}}`{{.}}`{{/example}}{{/tableCellContent}}
+    |{{#tableCellContent}}{{format}}{{/tableCellContent}}
 {{/fields}}
-|===
+    |===
diff --git a/src/test/resources/org/springframework/restdocs/templates/response-fields.snippet b/src/test/resources/org/springframework/restdocs/templates/response-fields.snippet
@@ -1,10 +1,11 @@
 |===
-|경로|타입|설명|예시
+    |경로|타입|설명|예시|형식
 
 {{#fields}}
-|{{#tableCellContent}}`{{path}}`{{/tableCellContent}}
-|{{#tableCellContent}}`{{type}}`{{/tableCellContent}}
-|{{#tableCellContent}}{{description}}{{/tableCellContent}}
-|{{#tableCellContent}}{{#example}}`{{.}}`{{/example}}{{/tableCellContent}}
+    |{{#tableCellContent}}`{{path}}`{{/tableCellContent}}
+    |{{#tableCellContent}}`{{type}}`{{/tableCellContent}}
+    |{{#tableCellContent}}{{description}}{{/tableCellContent}}
+    |{{#tableCellContent}}{{#example}}`{{.}}`{{/example}}{{/tableCellContent}}
+    |{{#tableCellContent}}{{format}}{{/tableCellContent}}
 {{/fields}}
-|===
+    |===