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

[ Week 8 ] Swagger 문서 작성 #5

Open

hyunn0121 opened this issue Nov 24, 2024 · 0 comments

Assignees

Labels

Member

hyunn0121 commented Nov 24, 2024

🛠 Mission

기존에 구현했던 API들에 Swagger 문서를 주석을 통해 만들기

📝 To-do

요청의 파라미터 (쿼리 파라미터, body) 정보가 잘 문서화 되어야 합니다.
응답의 성공 케이스가 문서화 되어야 합니다.
응답이 실패할 수 있는 경우, 실패하는 응답의 케이스도 문서화 되어야 합니다.

🔍 접근 방법

8주차 워크북의 내용을 기반으로 접근하겠습니다.

hyunn0121 added the ✨ feature label

hyunn0121 self-assigned this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment