[Docs] multipart/form-data 요청 형식 문서화
#117
Conversation
|
""" Walkthrough스토리 등록 요청의 필드명이 Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant Controller
participant Service
participant MapClient
Client->>Controller: 스토리 등록 요청(storeName 등 포함)
Controller->>Service: registerStory(request)
Service->>MapClient: searchShops(request.storeName)
MapClient-->>Service: 매장 검색 결과 반환
Service-->>Controller: 스토리 등록 결과 반환
Controller-->>Client: 응답 반환
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Suggested labels
Suggested reviewers
Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
src/main/java/eatda/controller/story/StoryRegisterRequest.java(1 hunks)src/main/java/eatda/service/story/StoryService.java(1 hunks)src/test/java/eatda/document/store/CheerDocumentTest.java(1 hunks)src/test/java/eatda/document/story/StoryDocumentTest.java(1 hunks)src/test/java/eatda/service/story/StoryServiceTest.java(2 hunks)
🧰 Additional context used
🧠 Learnings (3)
src/main/java/eatda/service/story/StoryService.java (1)
Learnt from: leegwichan
PR: #101
File: src/main/java/eatda/domain/story/Story.java:126-130
Timestamp: 2025-07-23T11:19:46.968Z
Learning: In Story.java, the validateStoreRoadAddress method only checks for null (not blank) because the Kakao API can legitimately return empty strings for roadAddress values in certain cases, so blank road addresses should be allowed.
src/main/java/eatda/controller/story/StoryRegisterRequest.java (1)
Learnt from: leegwichan
PR: #101
File: src/main/java/eatda/domain/story/Story.java:126-130
Timestamp: 2025-07-23T11:19:46.968Z
Learning: In Story.java, the validateStoreRoadAddress method only checks for null (not blank) because the Kakao API can legitimately return empty strings for roadAddress values in certain cases, so blank road addresses should be allowed.
src/test/java/eatda/service/story/StoryServiceTest.java (1)
Learnt from: leegwichan
PR: #101
File: src/main/java/eatda/domain/story/Story.java:126-130
Timestamp: 2025-07-23T11:19:46.968Z
Learning: In Story.java, the validateStoreRoadAddress method only checks for null (not blank) because the Kakao API can legitimately return empty strings for roadAddress values in certain cases, so blank road addresses should be allowed.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: test
🔇 Additional comments (7)
src/main/java/eatda/service/story/StoryService.java (1)
43-43: 필드명 변경이 올바르게 적용되었습니다.
request.query()에서request.storeName()으로의 변경이StoryRegisterRequest의 필드명 변경과 일치합니다.src/main/java/eatda/controller/story/StoryRegisterRequest.java (1)
4-4: 스토리 등록 API 필드명(query→storeName) 변경 – 클라이언트 영향 검증 필요
query에서storeName으로 필드명이 변경되어 의도가 더 명확해졌습니다. 다만 이는 API 계약을 변경하는 Breaking Change이므로, 클라이언트 애플리케이션(프론트엔드, 테스트, 문서 등)에 영향이 없는지 반드시 확인해 주세요.src/test/java/eatda/service/story/StoryServiceTest.java (2)
48-48: 테스트 모킹이 서비스 로직과 일치하도록 올바르게 업데이트되었습니다.
request.query()에서request.storeName()으로의 변경이 서비스 레이어 변경사항과 일관성을 유지합니다.
61-61: 실패 테스트 케이스도 일관되게 업데이트되었습니다.성공/실패 시나리오 모두에서 동일한 방식으로 필드명 변경이 적용되어 테스트 커버리지가 유지됩니다.
src/test/java/eatda/document/store/CheerDocumentTest.java (2)
42-55: multipart/form-data 요청 형식에 대한 상세한 문서화가 추가되었습니다.마크다운 형식의 문서화는 다음과 같은 장점을 제공합니다:
- 요청 형식과 필드 제약사항 명시
- 실제 사용 가능한 JSON 예시 제공
- 한국어 설명으로 로컬 개발자 친화적
이는 PR 목표인
multipart/form-data요청 형식 문서화를 효과적으로 달성합니다.
60-60: 문서화 개선이 적절히 적용되었습니다.새로 추가된 마크다운 상수를 사용하여 API 문서의 가독성과 유용성이 크게 향상되었습니다.
src/test/java/eatda/document/story/StoryDocumentTest.java (1)
61-61: 필드 경로가 올바르게 업데이트되었습니다.
"query"에서"storeName"으로의 변경이StoryRegisterRequest의 필드명 변경과 일치합니다.
|
|
🎉 This PR is included in version 1.4.0-develop.30 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 1.5.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
✨ 개요
multipart/form-data형식이com.epages:restdocs-api-spec에서 변환을 지원하지 않음🧾 관련 이슈
없음
🔍 참고 사항 (선택)
Summary by CodeRabbit
버그 수정
문서화