2022. 3. 31. 10:28ㆍBackEnd(Java)/Rest API
프로젝트 진행 시 진행 중인 업무 관련 내용들의 문서화 작업이 꼭 필요하다.(필요성은 말 안 해도 다 아신다고 생각한다.)
그중 API 서버를 개발하였으면 해당 API의 매뉴얼 및 Spec 등 문서화하는 과정이 필요하다.
하지만 문서작업은 기능이 추가되거나, 수정될 때마다 문서 작성하는 시간이 많이 소요되고 귀찮아서 잘 안 하게 된다.
그래서 자동화 툴을 찾게 되는데 Swagger라는 좋은 툴이 있다.
그중 API Spec 문서를 자동화하는 해주는 Swagger에 대해서 알아보자!
Swaager 설정
(개발 환경은 Spring Boot + Gradle 환경에서 세팅하였다)
여러 블로그랑 공식문서를 보면서 적용 테스트를 다양하게 해 봤는데 제일 빠른 방법을 알려주겠다.
1. Build.gradle 설정
아래 그림 2처럼 파란색으로 되어 있는 부분 2줄을 추가한다.(추가 후 코끼리 버튼 누르는 것을 잊지 마라)
2. Bean으로 등록할 class 생성
Bean으로 등록할 Class를 만들어서 아래 그림 3처럼 설정하면 된다.
코드 관련되서는 궁금하면 공식문서 or 구글에서 검색하면 잘 나온다.
3. http://localhost:8080/swagger-ui.html에 접속
서버 실행 후 위의 주소로 접속하면 api문서를 볼 수 있다!
ㄹㅇ 끝(간단하쥬? 😏)
하다가 잘 안되면 댓글로 남겨주세요!
참고사항
그림 4의 member-api-controller에서 post옆에 보면 "회원 등록"이라는 description이 있다.
이것을 적용하고 싶으면 아래 그림 5처럼 @ApiOperation어노테이션을 사용하여 value와 notes에 설명을 달아주면 됨!
참고 자료
'BackEnd(Java) > Rest API' 카테고리의 다른 글
| RestAPI에 대해서 제대로 알고 있는가? (0) | 2022.06.29 |
|---|---|
| RestAPI LocalDateTime 응답 데이터 포맷 변경 방법 (0) | 2022.05.22 |
| 이미지 업로드 및 조회 API 개발 2편 (0) | 2022.04.18 |
| 이미지 업로드 및 조회 API 개발 1편 (0) | 2022.04.17 |
| RestApi 참고자료 (0) | 2022.03.29 |