<aside> 💡 스웨거(Swagger)는 API 문서를 자동으로 생성하고 표시해주는 도구입니다. 개발자가 작성한 API 엔드포인트, 요청 및 응답 형식, 매개변수 등의 세부 정보를 시각적으로 표현하여 API의 사용 방법을 명확하게 전달합니다.

</aside>

<aside> 🗣 스웨거를 사용하면 API 문서 작성과 업데이트에 드는 번거로움을 줄일 수 있으며, 개발자와 클라이언트 간의 의사소통을 원활하게 만들어줍니다. 또한, 스웨거 UI를 통해 API를 직접 테스트할 수 있으므로 개발 및 디버깅 과정에서 유용하게 활용할 수 있습니다.

</aside>

  1. 스웨거 링크 접속

  2. 테스트하고자 하는 controller 선택 [banner-controller 클릭]

    스크린샷 2023-07-04 오후 11.03.50.png

  3. 테스트하고자 하는 메서드 선택 [가장 첫 번째 아이템 박스 선택 : POST, /api/banner]

    스크린샷 2023-07-04 오후 11.04.18.png

  4. Try it out 클릭 [아래 사진의 우측 상단에 위치]

    스크린샷 2023-07-04 오후 11.04.41.png

  5. 데이터 작성 후 execute 클릭 (GET 메서드인 경우, 데이터 작성 필요 없음)

    [화면 중앙의 흰색 부분에 기입할 데이터 작성하며 아래 사진의 하단 부의 Execute 버튼 클릭]

    스크린샷 2023-07-04 오후 11.05.05.png

    일부 PATCH 메서드(논리적 삭제 메서드)의 경우 파라미터 기입 후 execute 클릭

    [화면 좌측 하단 부의 하얀색 박스에 숫자(1) 기입 후 아래 사진의 하단 부의 Execute 버튼 클릭]

    스크린샷 2023-07-04 오후 11.14.07.png

  6. 스크롤 다운하여 결과 확인

    [요청 후 성공] → Server Response의 code 값이 200임을 확인

    스크린샷 2023-07-04 오후 11.08.10.png

    [요청 후 에러 발생] → Response body에서 에러 메시지 확인할 것

    [메시지 일부 → 이미 등록된 배너입니다]

    스크린샷 2023-07-04 오후 11.07.53.png

※ 참고사항

[필드별 설명]