Skip to content

[Docs] Swagger 문서 누락/오류 수정 #127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lvalentine6 merged 2 commits into from
Jul 31, 2025
Merged

[Docs] Swagger 문서 누락/오류 수정 #127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
def7d0f
fix: '스토리 여러개 조회 API'에 문서에 누락된 쿼리 파라미터 추가
leegwichan Jul 31, 2025
28fbd8b
fix: '음식점 목록 조회 API'에 category 의 잘못된 값 수정
leegwichan Jul 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/test/java/eatda/document/store/StoreDocumentTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ class GetStores {
.queryParameter(
parameterWithName("size").description("조회할 음식점 개수 (최소 1, 최대 50)"),
parameterWithName("category")
.description("음식점 카테고리(기본값: 전체) (한식,중식,일식,양식,디저트/카페,기타)").optional()
.description("음식점 카테고리(기본값: 전체) (한식,중식,일식,양식,카페/디저트,기타)").optional()
);

RestDocsResponse responseDocument = response()
Expand Down
6 changes: 5 additions & 1 deletion src/test/java/eatda/document/story/StoryDocumentTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import static org.mockito.Mockito.doThrow;
import static org.springframework.restdocs.headers.HeaderDocumentation.headerWithName;
import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;
import static org.springframework.restdocs.request.RequestDocumentation.parameterWithName;
import static org.springframework.restdocs.request.RequestDocumentation.partWithName;

import eatda.controller.story.StoriesResponse;
Expand Down Expand Up @@ -117,7 +118,10 @@ class GetStories {
RestDocsRequest requestDocument = request()
.tag(Tag.STORY_API)
.summary("스토리 목록 조회")
.description("스토리 목록을 페이지네이션하여 조회합니다.");
.description("스토리 목록을 페이지네이션하여 조회합니다.")
.queryParameter(
parameterWithName("size").description("스토리 개수 (기본값: 5) (최소값: 1, 최대값: 50)").optional()
);

RestDocsResponse responseDocument = response()
.responseBodyField(
Expand Down