Swagger API 문서

jayjay28·2019년 8월 26일
0

SpringBoot

목록 보기
8/12
post-thumbnail

Swagger

스웨거는 API 문서를 자동화 해줍니다! 개꿀....
그뿐만 아니라 웹 UI를 이용해 테스트도 진행 가능합니다!

선행 조건

  1. Intellij의 springboot initializer를 통해 spring boot 프로젝트를 생성했습니다.
  2. maven을 사용합니다.
  3. swagger2를 사용합니다.
  4. Lombok을 사용합니다.

적용 방법

프로젝트 구조

캡처.PNG

소스 전문 보기

Github 주소

1. 의존성 추가

pom.xml에 다음과 같이 추가해줍니다.

2. config 클래스 작성

3. 테스트를 위한 Account 클래스 작성

4. Repository 인터페이스 정의

5. Controller 작성

6. 어플리케이션 실행 후 확인

http://localhost:8080/swagger-ui.html 에서 확인 가능합니다.
문서 확인 뿐만 아니라 get, post, delete, put 메소드를 이용한 테스트도 진행이 가능합니다.

캡처.1PNG.PNG

profile
@탈주범 및 프론트엔드 개발자

0개의 댓글