[Spring] Rest-swagger 사용해보기

🥘 SwaggerConfig.java

rest - 폴더 명 : config 생성

config - 파일 명 : SwaggerConfig.java 생성

package com.example.rest.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(getApiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.rest"))
                .paths(PathSelectors.ant("/**"))
                .build();
    }

    private ApiInfo getApiInfo() {
        return new ApiInfoBuilder()
        .title("Spring Boot Open API Test with Swagger")
        .description("설명 부분")
        .version("1.0.0")
        .build();
    }
}

코드 추가

---

🍫 application.properties

server.port=8090
spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER

코드 추가

---

서버 실행 후,
http://localhost:8090/swagger-ui.html Chrome에 검색하면

이렇게 나온다!

---

🍊 Controller.java

@ApiParam(value="이름", required=true),
@ApiParam(value="저자", required=false) 추가하기

서버 재실행

getBookWithParam 클릭

name은 *required 로 표시되어있다!

Description에 각각 저자, 이름 으로 표시된다.

그냥 @ApiParam을 통해서 설정을 초기화 해본 것 뿐이다. 크게 중요하지 x