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.

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

Jump to bottom

Springdoc을 이용한 응답 예제값 설정 및 문서화 추가 #591

Open
limehee opened this issue Oct 14, 2024 · 0 comments
Open

Springdoc을 이용한 응답 예제값 설정 및 문서화 추가 #591

limehee opened this issue Oct 14, 2024 · 0 comments
Assignees
@limehee
Labels
✨ Feature 새로운 기능 명세 및 개발

Comments

@limehee
Copy link
Collaborator

limehee commented Oct 14, 2024 •
edited
Loading

Describe

현재 Springdoc(Swagger)을 통해 API 문서화가 이루어지고 있지만, 응답에 대한 예제값 설정에 대한 문서화가 누락되어 있습니다. 누락된 정보를 추가하여 API 사용자가 응답 형식을 더 명확하게 이해하고, 클라이언트가 요청 결과를 올바르게 처리할 수 있도록 합니다.

Tasks

  • 응답 예제값 설정
    • Springdoc 어노테이션을 사용하여 각 ResponseDto에 대한 예제값 설정
    • 각 필드의 설명과 예제값을 명확하게 문서화
@limehee limehee added the ✨ Feature 새로운 기능 명세 및 개발 label Oct 14, 2024
@limehee limehee self-assigned this Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@limehee limehee

Labels
✨ Feature 새로운 기능 명세 및 개발
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@limehee