[#23]feat: swagger 코드 추가 - Githubissues

edu-pi / Backend-User-Server

0 stars 0 forks source link

[#23]feat: swagger 코드 추가 #24

Closed ujkkk closed 2 weeks ago

ujkkk commented 3 weeks ago

️⃣ 연관된 이슈

23

📝 작업 내용

자동 API 명세 기능을 위해 Swagger를 도입했습니다.
postman 처럼 바로 api 호출해서 테스트할 수 도 있습니다.
서버 띄우고 http://localhost:8083/edupi_user/v1/swagger-ui/index.html 로 접속하면 됩니다.

스크린샷

스크린샷 2024-08-29 14 47 13

💬 리뷰 요구사항(선택)

login과l login/info 의 차이점을 몰라서 우선 설명을 동일하게 '로그인'으로 해놨습니다. 차이점 알려주면 반영하겠습니다.
우선 현재 Swagger에 명시할 것은 api 설명, 반환 값 설명로 정했습니다. 같이 논의해봐요~