스웨거를 보지 않고 Api명세서만 보고 만들 경우에

5월 7일조회 221

백엔드에서 만들어주는 스웨거가 완성이 되지않아서 제가 Api명세서만 보고 만들어야 하는 상황이 생겼었는데 이런 경우에 정확히 어떤 문제점들이 생기나요?? 추가 질문으로 백엔드에서 스웨거를 먼저 작업해주는 게 협업에서 좋은 거 아닌가라는 의문이 생기는데 맞나요??

질문을 추천하시나요?

답변 3

ho님의 프로필 사진

1. 스웨거는 API 명세서를 코드로 자동화 시키는 것이기 때문에 명세서만 있는 것은 문제가 되지 않습니다. 다만 명세서의 잦은 변경이 공유되지 않거나 명세서와 실제 코드의 동작이 다른 경우는 문제가 될 수 있습니다. 2. API 명세서가 잘 작성되어있고 변경 사항 공유와 코드가 문서대로 잘 동작한다면 협업에 문제는 없습니다. 이미 문서가 작성되어 있으면 백엔드쪽에서 스웨거만을 위해 컨트롤러쪽만 우선적으로 개발하는게 큰 의미는 없기 때문에 스웨거 작업이 우선순위가 아닐 수 있을 것 같습니다.

세준님의 프로필 사진

세준

작성자

프론트엔드5월 8일

아하 답변 감사합니다!! 백엔드쪽에서 정확히 언제 스웨거를 작성하는지 몰랐어서 먼저 작성하는 걸로 착각했던 거 같습니다!! 감사합니다!

황민호님의 프로필 사진

백엔드에서 스웨거를 제공하려면 1. Mock 데이터로 일단 스펙만 맞춰주거나 2. 개발이 완료된 상태 에서 가능합니다. 물론 스웨거가 있다면 확실히 프론트 개발 시 도움이 됩니다만 백엔드 개발 일정과 병행으로 가는 것이라면 API 명세가 있으니 그것으로 프론트 개발을 진행하시면 될 것 같습니다. 이후 각종 예외 상황들에 대해 API에서 어떻게 처리하고 있는지 확인해서, 프론트에도 적용하는 개선 작업 및 디버깅 용도로 사용하시면 되지 않을까 싶습니다.

세준님의 프로필 사진

세준

작성자

프론트엔드5월 8일

Api만으로 진행해도 문제가 없었군요! 백엔드에서 언제 스웨거를 만들어주는지 정확한 방법이나 이해가 되지않아서 생겼던 문제점인 거 같아요!! 자세한 답변 감사합니다!

커리어리 AI 봇님의 프로필 사진

스웨거(Swagger)는 API를 정의, 생성, 문서화, 테스트하기 위한 프레임워크입니다. API 명세서만 보고 개발하는 경우와 스웨거를 이용하는 경우에는 몇 가지 차이점이 있습니다. 1. 문서화: 스웨거는 API를 시각적으로 문서화하고, 이를 통해 API를 이해하고 사용하는 것이 더 쉬워집니다. 따라서 스웨거가 없는 경우, API 명세서의 품질이 매우 중요해집니다. 상세하지 않거나 정확하지 않은 명세서는 개발에 혼란을 줄 수 있습니다. 2. 테스트: 스웨거는 API 테스트를 쉽게 해주는 기능을 제공합니다. 이를 통해 개발자는 API가 예상대로 동작하는지 확인할 수 있습니다. 스웨거가 없는 경우, 개발자는 별도의 테스트 도구를 사용해야 합니다. 3. 협업: 스웨거는 팀원 간에 API 명세를 공유하고 이해하는데 도움을 줍니다. 따라서 스웨거가 없는 경우, 팀 내에서 API에 대한 이해도가 다를 수 있고 이로 인해 문제가 발생할 수 있습니다. 백엔드에서 스웨거를 먼저 작업하는 것이 협업에 좋은 이유는 위와 같습니다. 스웨거를 통해 API를 시각적으로 문서화하고, 이를 공유함으로써 팀원 간의 이해도 차이를 줄일 수 있습니다. 또한, 스웨거를 통해 API를 테스트하고 문제를 빠르게 파악할 수 있습니다. 따라서 가능하다면 스웨거를 사용하는 것이 좋습니다.

커리어리 AI 봇의 답변을 평가해 주세요!

지금 가입하면 모든 질문의 답변을 볼 수 있어요!

현직 개발자들의 명쾌한 답변을 얻을 수 있어요.

또는

이미 회원이신가요?

목록으로
키워드로 질문 모아보기

기술, 커리어 고민이 있다면

새로운 질문 올리기

지금 가입하면 모든 질문의 답변을 볼 수 있어요!

이메일로 가입하기