Feature/199 spring swagger

build.gradle

@@ -69,6 +69,10 @@ dependencies {
 
 	//spring aop
 	implementation 'org.springframework.boot:spring-boot-starter-aop'
+
+	//Swagger
+	implementation group: 'io.springfox', name: 'springfox-swagger2', version: '3.0.0'
+	implementation group: 'io.springfox', name: 'springfox-swagger-ui', version: '2.9.2'
 }
 
 tasks.named('test') {

src/main/java/com/sptp/backend/common/config/SwaggerConfig.java

@@ -0,0 +1,40 @@
+package com.sptp.backend.common.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.security.core.annotation.AuthenticationPrincipal;
+import springfox.documentation.builders.ApiInfoBuilder;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.service.ApiInfo;
+import springfox.documentation.service.Contact;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+import java.util.Collections;
+
+@Configuration
+@EnableSwagger2
+public class SwaggerConfig {
+    @Bean
+    public Docket api() {
+        return new Docket(DocumentationType.SWAGGER_2)
+                .ignoredParameterTypes(AuthenticationPrincipal.class)
+                .select()
+                .apis(RequestHandlerSelectors.any())
+                .paths(PathSelectors.any())
+                .build()
+                .apiInfo(apiInfo());
+    }
+
+    private ApiInfo apiInfo() {
+        return new ApiInfo(
+                "Atties REST API TEST",
+                "아띠즈 API 문서 목록",
+                "V1",
+                "Terms of service",
+                new Contact("administrator", "www.example.com", "administrator@email.com"),
+                "License of API", "www.example.com", Collections.emptyList());
+    }
+}

src/main/java/com/sptp/backend/common/config/WebSecurityConfig.java

@@ -53,6 +53,14 @@ protected void configure(HttpSecurity http) throws Exception {
                 .antMatchers(HttpMethod.PATCH, "/artists").hasAnyRole("ARTIST", "ADMIN")
                 .antMatchers(HttpMethod.POST, "/art-works").hasAnyRole("ARTIST", "ADMIN")
                 .antMatchers("/admin/**").hasRole("ADMIN")
+                .antMatchers("/swagger-ui/**").permitAll() // TODO : 추후에 따로 권한 설정 논의 필요
+                .antMatchers("/swagger-ui.html").permitAll() // TODO : 추후에 따로 권한 설정 논의 필요
+                .antMatchers("/api/v2/**").permitAll() // TODO : 추후에 따로 권한 설정 논의 필요
+                .antMatchers("/v2/api-docs/**").permitAll() // TODO : 추후에 따로 권한 설정 논의 필요
+                .antMatchers("/swagger/**").permitAll() // TODO : 추후에 따로 권한 설정 논의 필요
+                .antMatchers("/swagger-resources/**").permitAll() // TODO : 추후에 따로 권한 설정 논의 필요
+                .antMatchers("/webjars/**").permitAll() // TODO : 추후에 따로 권한 설정 논의 필요
+
                 .anyRequest().authenticated(); // 그외 나머지 요청은 인증 필요
 
         http.addFilterBefore(jwtAuthenticationFilter, UsernamePasswordAuthenticationFilter.class);
@@ -76,6 +84,7 @@ public CorsConfigurationSource corsConfigurationSource() {
         CorsConfiguration configuration = new CorsConfiguration();
 
         configuration.addAllowedOrigin("http://localhost:3000");
+        configuration.addAllowedOrigin("http://localhost:8080");
         configuration.addAllowedOrigin("https://atties.vercel.app");
         configuration.addAllowedOrigin("https://attiess.netlify.app");
         configuration.addAllowedHeader("*");

src/main/java/com/sptp/backend/member/web/dto/request/ArtistUpdateRequest.java

@@ -1,5 +1,6 @@
 package com.sptp.backend.member.web.dto.request;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.*;
 
 import java.util.List;
@@ -11,14 +12,24 @@
 @Builder
 public class ArtistUpdateRequest {
 
+    @ApiModelProperty(required = true, value = "유저 닉네임", example = "아라")
     private String nickname;
+    @ApiModelProperty(required = true, value = "유저 이메일", example = "test1234@naver.com")
     private String email;
+    @ApiModelProperty(required = true, value = "학력", example = "xx대학교 xx학과")
     private String education;
+    @ApiModelProperty(required = true, value = "이력", example = "이력입니다.")
     private String history;
+    @ApiModelProperty(required = true, value = "소개,설명", example = "소개글입니다.")
     private String description;
+    @ApiModelProperty(required = true, value = "인스타그램 주소", example = "www.instagram.com")
     private String instagram;
+    @ApiModelProperty(required = true, value = "비헨스 주소", example = "www.behance.com")
     private String behance;
+    @ApiModelProperty(required = true, value = "유저 주소", example = "서울시 xx구 xx동 123동 1234호")
     private String address;
+    @ApiModelProperty(required = true, value = "유저 연락처", example = "01012345678")
     private String telephone;
+    @ApiModelProperty(required = true, value = "이미지 변경 여부", example = "true")
     private Boolean isChanged;
 }

src/main/java/com/sptp/backend/member/web/dto/request/MemberAnswerRequest.java

@@ -1,5 +1,6 @@
 package com.sptp.backend.member.web.dto.request;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.*;
 
 @Getter
@@ -9,5 +10,6 @@
 @Builder
 public class MemberAnswerRequest {
 
+    @ApiModelProperty(required = true, value = "문의 글 답변", example = "답변")
     private String answer;
 }

src/main/java/com/sptp/backend/member/web/dto/request/MemberAskRequestDto.java

@@ -1,5 +1,6 @@
 package com.sptp.backend.member.web.dto.request;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.*;
 import org.springframework.web.multipart.MultipartFile;
 
@@ -10,7 +11,10 @@
 @Builder
 public class MemberAskRequestDto {
 
+    @ApiModelProperty(required = true, value = "문의 글 제목", example = "제목")
     private String title;
+    @ApiModelProperty(required = true, value = "문의 글 내용", example = "내용")
     private String content;
+    @ApiModelProperty(required = true, value = "문의 글 첨부 사진")
     private MultipartFile[] image;
 }

src/main/java/com/sptp/backend/member/web/dto/request/MemberLoginRequestDto.java

@@ -1,5 +1,6 @@
 package com.sptp.backend.member.web.dto.request;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.*;
 
 @Getter
@@ -9,6 +10,8 @@
 @Builder
 public class MemberLoginRequestDto {
 
+    @ApiModelProperty(required = true, value = "유저 아이디", example = "test1234")
     private String userId;
+    @ApiModelProperty(required = true, value = "유저 패스워드", example = "password1234")
     private String password;
 }

src/main/java/com/sptp/backend/member/web/dto/request/MemberSaveRequestDto.java

@@ -1,5 +1,6 @@
 package com.sptp.backend.member.web.dto.request;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.*;
 
 import java.util.List;
@@ -11,11 +12,17 @@
 @Builder
 public class MemberSaveRequestDto {
 
+    @ApiModelProperty(required = true, value = "유저 닉네임", example = "아라")
     private String nickname;
+    @ApiModelProperty(required = true, value = "유저 아이디", example = "test1234")
     private String userId;
+    @ApiModelProperty(required = true, value = "유저 이메일", example = "test1234@naver.com")
     private String email;
+    @ApiModelProperty(required = true, value = "유저 패스워드", example = "password1234")
     private String password;
+    @ApiModelProperty(required = true, value = "유저 연락처", example = "01012345678")
     private String telephone;
+    @ApiModelProperty(required = true, value = "유저 관심 키워드", example = "화려한,유화")
     private List<String> keywords;
 
 }

src/main/java/com/sptp/backend/member/web/dto/request/MemberUpdateKeywordsRequestDto.java

@@ -1,5 +1,6 @@
 package com.sptp.backend.member.web.dto.request;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.*;
 
 import java.util.List;
@@ -11,5 +12,6 @@
 @Builder
 public class MemberUpdateKeywordsRequestDto {
 
+    @ApiModelProperty(required = true, value = "유저 관심 키워드", example = "['화려한','유화']")
     private List<String> keywords;
 }

src/main/java/com/sptp/backend/member/web/dto/request/MemberUpdateRequest.java

@@ -1,5 +1,6 @@
 package com.sptp.backend.member.web.dto.request;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.*;
 
 import java.util.List;
@@ -11,9 +12,14 @@
 @Builder
 public class MemberUpdateRequest {
 
+    @ApiModelProperty(required = true, value = "유저 닉네임", example = "아라")
     private String nickname;
+    @ApiModelProperty(required = true, value = "유저 이메일", example = "test1234@naver.com")
     private String email;
+    @ApiModelProperty(required = true, value = "유저 주소", example = "서울시 xx구 xx동 123동 1234호")
     private String address;
+    @ApiModelProperty(required = true, value = "유저 연락처", example = "01012345678")
     private String telephone;
+    @ApiModelProperty(required = true, value = "이미지 변경 여부", example = "true")
     private Boolean isChanged;
 }

src/main/java/com/sptp/backend/member/web/dto/request/PasswordChangeRequest.java

@@ -1,5 +1,6 @@
 package com.sptp.backend.member.web.dto.request;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.*;
 import org.hibernate.validator.constraints.Length;
 
@@ -12,6 +13,7 @@
 @Builder
 public class PasswordChangeRequest {
 
+    @ApiModelProperty(required = true, value = "유저 비밀번호", example = "password1234")
     @Length(min = 8, message = "비밀번호는 8자 이상 입력해주세요.")
     @NotBlank(message = "비밀번호는 공백일 수 없습니다.")
     private String password;

src/main/resources/application.yml

@@ -4,6 +4,10 @@ server:
 
 spring:
 
+  mvc:
+    pathmatch:
+      matching-strategy: ant_path_matcher
+
   servlet:
     multipart:
       max-file-size: 10MB