Skip to content

Commit 5a02e67

Browse files
committed
docs : multipart/form-data 요청 형식 문서화
1 parent 95c622c commit 5a02e67

File tree

2 files changed

+32
-1
lines changed

2 files changed

+32
-1
lines changed

src/test/java/eatda/document/store/CheerDocumentTest.java

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,25 @@ public class CheerDocumentTest extends BaseDocumentTest {
3939
@Nested
4040
class RegisterCheer {
4141

42+
private static final String REQUEST_DESCRIPTION_MARKDOWN = """
43+
- 요청 형식 : multipart/form-data
44+
- 요청 field
45+
- `image` : 응원 이미지 (선택, 최대 5MB, 허용 타입 : image/jpg, image/jpeg, image/png
46+
- `request` : 응원 등록 요청 정보 (필수, 허용 타입 : application/json)
47+
- request body 예시
48+
```json
49+
{
50+
"storeKakaoId": "123", // 가게 카카오 ID
51+
"storeName": "농민백암순대 본점", // 가게 이름
52+
"description": "너무 맛있어요! 준환님 추천 맛집!" // 응원 내용
53+
}
54+
```
55+
""";
56+
4257
RestDocsRequest requestDocument = request()
4358
.tag(Tag.STORE_API)
4459
.summary("응원 등록")
60+
.description(REQUEST_DESCRIPTION_MARKDOWN)
4561
.requestHeader(
4662
headerWithName("Authorization").description("인증 토큰")
4763
).multipartField(

src/test/java/eatda/document/story/StoryDocumentTest.java

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,25 @@ public class StoryDocumentTest extends BaseDocumentTest {
3333
@Nested
3434
class RegisterStory {
3535

36+
private static final String REQUEST_DESCRIPTION_MARKDOWN = """
37+
- 요청 형식 : multipart/form-data
38+
- 요청 field
39+
- `image` : 응원 이미지 (선택, 최대 5MB, 허용 타입 : image/jpg, image/jpeg, image/png
40+
- `request` : 응원 등록 요청 정보 (필수, 허용 타입 : application/json)
41+
- request body 예시
42+
```json
43+
{
44+
"storeKakaoId": "123", // 가게 카카오 ID
45+
"storeName": "농민백암순대 본점", // 가게 이름
46+
"description": "너무 맛있어요! 준환님 추천 맛집!" // 응원 내용
47+
}
48+
```
49+
""";
50+
3651
RestDocsRequest requestDocument = request()
3752
.tag(Tag.STORY_API)
3853
.summary("스토리 등록")
39-
.description("스토리와 이미지를 multipart/form-data로 등록합니다.")
54+
.description(REQUEST_DESCRIPTION_MARKDOWN)
4055
.requestHeader(
4156
headerWithName(HttpHeaders.AUTHORIZATION).description("액세스 토큰")
4257
).multipartField(

0 commit comments

Comments
 (0)