Springboot - restapi

노요셉·2020년 10월 28일
0

https://daddyprogrammer.org/post/313/swagger-api-doc/

Swagger API

swagger를 gradle dependency에 추가

implementation 'io.springfox:springfox-swagger2:2.6.1'
implementation 'io.springfox:springfox-swagger-ui:2.6.1'

gradle dependency complie, implementation 차이
https://jongmin92.github.io/2019/05/09/Gradle/gradle-api-vs-implementation/

Gradle Document

api 또는 compile: 의존 라이브러리 수정시 해당 모듈을 의존하고 있는 모듈들 또한 재빌드

A(api) <- B <- C 일 때, C 에서 A 를 접근할 수 있음
A 수정시 B 와 C 모두 재빌드

implementation: 의존 라이브러리 수정시 본 모듈까지만 재빌드

A(implementation) <- B <- C 일 때, C 에서 A 를 접근할 수 없음
A 수정시 B 까지 재빌드

SwaggerConfiguration 작성

Swagger를 위한 Configuration이 필요함.

Controller에 Swagger 어노테이션 붙이기

실질적으로 API 요청의 최전방에 해당하는 Controller에 Swagger 나올 컨트롤러를 정해서 어노테이션 붙임.

profile
서로 아는 것들을 공유해요~

0개의 댓글