Skip to content
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.

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

Step0 #409

Open
wants to merge 4 commits into
base: michaelkimm
Choose a base branch
from
Open

Step0 #409

wants to merge 4 commits into from

Conversation

michaelkimm
Copy link

@michaelkimm michaelkimm commented Aug 28, 2023

취준 중에 강의를 듣다 보니 면접과 병행하게 되어 뒤 늦게 PR을 올렸네요:( 고민 많이 해보며 설계하고 코드 작성해보겠습니다 잘부탁드립니다! 한솔님!:)

구현 사항

  • 경로 찾기 기능을 문서화하기 위한 테스트를 작성
  • 테스트 작성 후 Spring Rest Docs 적용을 통해 문서에 기재할 정보를 설정
    • request parameter, response field 추가
스크린샷 2023-08-28 오후 12 25 13 스크린샷 2023-08-28 오후 12 25 19

질문

  1. PathResponse Dto가 List<StationResponse>를 필드로 가지고 있을 경우, StationResponse 문서화에 대한 정보가 StationDocumentation에도 있을 것이고, PathDocumentation에도 있는 문제가 생깁니다. 간단하게 생각하면 PathResponse가 가지고 있는 List<StationResponse>List<PathStationResponse>로 변경하여 아예 새로운 Response를 생성하는 방법이 있을 듯 합니다. 하지만 이 방법은 코드 재사용성이 떨어져 관리해야할 코드가 많아지는 단점이 있습니다. 한솔님은 어떻게 생각하시나요?

// StationResponse의 필드가 추가되면 PathResponse의 Restdocs에도 반영 필요 -> 유지보수 어려움.
// then how?
return responseFields(
fieldWithPath("stations[].id").description("지하철 역 아이디"),
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

질문과 관련된 코드입니다!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant