Swagger

Swagger : 개발한 REST API를 편리하게 문서화 하여 관리 및 제3 사용자가 편하게 API를 호출해보고 테스트 할 수 있는 프로젝트

 

SpringBoot는 springfox-boot-starter를 아래와 같이 gradle dependencies에 추가하주면 사용이 가능.

 implementation group: 'io.springfox', name: 'springfox-boot-starter', version: '3.0.0'

 

근데! 노출되면 안되는 곳에서 사용할 땐 주의해야 한당.

 

@APi	클래스를 swagger의 resource로 표시
@ApiOperation	특정 경로의 operation HTTP method 설명
@ApiParam	opration parameter에 meta data 설명
@ApiResponse	operation의 reponse 지정
@ApiModelProperty	model의 property data 설명
@ApiImplicitParam	method단위의 operation parameter를 설명
@ApiImplicitParams

1. 간단한 Controller 작성을 해보자.

get method로 hello를 return하는 controller이다.

@RequestMapping("/api")
public class Controller {

    @GetMapping("/hello")
    public String hello(){
        return "hello";
    }
}

 실행을 시키면 아래와 같이 swagger가 작동하는걸 확인이 가능하다.

com.example.swagger.SwaggerApplication   : 
Started SwaggerApplication in 1.63 seconds (JVM running for 2.442)

 

2. Swagger-ui

정상적으로 실행되었으면 swagger ui 접속이 가능하다.

 http://localhost:8080/swagger-ui/

swagger-ui 접속 화면

swagger-ui 화면에서 우리가 작성한  controller를 확인이 가능하다.

(basic-error-controller는 spring boot에서 기본으로 제공하는 controller)

 

controller를 클릭하면 아래와 method를 확인할 수 있다.

method를 클릭하면 아래처럼 화면이 뜨는데, Try it out을 클릭해보자.

Execute를 클릭하면 method를 실행시키고 response 확인이 가능하다.

즉 내가 작성한 controller를 문서를 작성해서 다른 사람한테 정보를 제공하는 것이 아니라, swagger-ui를 제공하여 제3 사용자가 간단히 test를 할 수 있게됨.