Swagger를 통한 API 명세서 작성

[kjoon418]

✨ 기능 설명

• Swagger를 통해 API 명세서를 자동으로 작성하고, API를 쉽게 테스트할 수 있도록 합니다.

💡 기대하는 동작

1. API 명세서를 직접 작성할 필요가 없어지거나, 간략하게만 작성해도 되게 개선됩니다.
2. 포스트맨 없이도 Swagger를 통해 API를 호출할 수 있습니다.

📌 Swagger 사용법

API 명세서 접속

• <서버 도메인>/swagger-ui/index.html로 접속합니다.(만약 개발 환경이라면 localhost:8080/swagger-ui/index.html이 되겠죠?)

API 스펙 확인

• API를 클릭해서 상세 스펙을 확인할 수 있습니다.

API 테스트

• Try it out 버튼을 통해 API를 호출할 수 있습니다.
• 만약 Access Token 혹은 Refresh Token이 필요한 API를 테스트하고 싶다면, 회원가입 API 호출을 통해 토큰을 발급받으십시오.

📌 코드를 통해 API 명세서 설명 추가하기

• 컨트롤러 클래스에 @Tag 어노테이션을 추가합니다.
• 해당 어노테이션의 name 속성과 description 속성에 적절한 설명을 입력합니다.

• 액션 메서드에 @Operation 어노테이션을 추가합니다.
• 해당 어노테이션의 summary 속성과 description 속성에 적절한 설명을 입력합니다.