Swagger 정확히 사용하기

지수님·2024년 2월 17일
post-thumbnail

Swagger에도 알아야 할게 있었다니..!

문제

프로젝트를 진행하면서 주어진 스웨거에 정해진 api 요청 주소로 요청을 보내면
응답은 정상적으로 오지만 응답 속 관련 내용이 모두 비워져 있는 상태로 응답이와서
어떤게 문제인지 알 수가 없었다 응답없이 에러만 왔다면 코드 문제거니 했을텐데
이유를 알 수 없어 몇시간을 버렸다..ㅠㅠ

원인

아무리.. 코드를 수정해봐도 빈 배열만 응답이 와서 스웨거를 다시 확인해 보았다
required(필수 값)가 써진 입력 칸이 따로 있어서 해당 입렵창만 채워 요청 보내 보았더니
배열에 정상적으로 데이터가 채워져 응답이 왔다!!

스웨거를 사용할 때 필수로 넣어야 하는 값, 그렇지 않은 값이 따로 있다는 걸 몰라서
스웨거에 나온 값을 항상 다 넣어서 요청을 보낸게 근본적인 원인 이었다

해결 & 느낀 점

먼저 필수 값(required)을 넣어보고 응답을 확인해 봐야 하는 상황도 있다
나머지 값의 추가 여부에 따라 응답 내용이 달라지기 때문이다
이유를 알고나니.. 코드만 계속 수정한 시간이 아까웠다ㅠㅡㅠ

profile
되어보자 개발자!

0개의 댓글