- 코드 주석 추가

jhjang

2022-01-06 dc12a6a3e3dbe7088b54a1bb02cfc98cf7c230c0

 src/main/java/kr/wisestone/owl/config/SwaggerConfig.java

@@ -17,6 +17,9 @@
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * API 문서 제작 패키지 Swagger 설정 클래스
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@@ -25,6 +28,11 @@
    private static final String API_VERSION = "1.0.0";
    private static final String API_DESCRIPTION = "OWL API 명세서";


    /**
     * API 설정
     * @return docket class
     */
    @Bean
    public Docket api() {
//        Parameter parameterBuilder = new ParameterBuilder()
@@ -49,6 +57,11 @@
                .build();
    }


    /**
     * API 문서 타이틀/버전/설명 설정
     * @return ApiInfo 클래스
     */
    public ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(API_NAME)
@@ -57,6 +70,11 @@
                .build();
    }


    /**
     * API 문서 테스트 Request Content-Type 설정 추가
     * @return consumes content-type 목록
     */
    private Set<String> getConsumeContentTypes() {
        Set<String> consumes = new HashSet<>();
        consumes.add("application/json;charset=UTF-8");
@@ -64,6 +82,10 @@
        return consumes;
    }

    /**
     * API 문서 테스트 Response content-type 설정 추가
     * @return produce content-type 목록
     */
    private Set<String> getProduceContentTypes() {
        Set<String> produces = new HashSet<>();
        produces.add("application/json;charset=UTF-8");