7차 세미나 - springDocs Swagger #15

GO-SOPT-SERVER · May 27, 2023 · 2d7ed39 · 2d7ed39
1 parent d2ea153
commit 2d7ed39
Show file tree

Hide file tree

Showing 36 changed files with 106 additions and 96 deletions.
diff --git a/...org/fourthSeminar/AuditingTimeEntity.java → ...rg/seventhSeminar/AuditingTimeEntity.java b/...org/fourthSeminar/AuditingTimeEntity.java → ...rg/seventhSeminar/AuditingTimeEntity.java
@@ -1,4 +1,4 @@
-package sopt.org.fourthSeminar;
+package sopt.org.seventhSeminar;
 
 import lombok.Getter;
 import org.springframework.data.annotation.CreatedDate;

diff --git a/...rthSeminar/SeventhSeminarApplication.java → ...nthSeminar/SeventhSeminarApplication.java b/...rthSeminar/SeventhSeminarApplication.java → ...nthSeminar/SeventhSeminarApplication.java
@@ -1,4 +1,4 @@
-package sopt.org.fourthSeminar;
+package sopt.org.seventhSeminar;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;

diff --git a/...sopt/org/fourthSeminar/aws/S3Service.java → ...opt/org/seventhSeminar/aws/S3Service.java b/...sopt/org/fourthSeminar/aws/S3Service.java → ...opt/org/seventhSeminar/aws/S3Service.java
@@ -1,4 +1,4 @@
-package sopt.org.fourthSeminar.aws;
+package sopt.org.seventhSeminar.aws;
 
 
 import com.amazonaws.auth.AWSStaticCredentialsProvider;
@@ -13,9 +13,9 @@
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Service;
 import org.springframework.web.multipart.MultipartFile;
-import sopt.org.fourthSeminar.controller.exception.Error;
-import sopt.org.fourthSeminar.controller.exception.model.BadRequestException;
-import sopt.org.fourthSeminar.controller.exception.model.NotFoundException;
+import sopt.org.seventhSeminar.controller.exception.Error;
+import sopt.org.seventhSeminar.controller.exception.model.BadRequestException;
+import sopt.org.seventhSeminar.controller.exception.model.NotFoundException;
 import javax.annotation.PostConstruct;
 import java.io.IOException;
 import java.io.InputStream;

diff --git a/...t/org/fourthSeminar/config/WebConfig.java → .../org/seventhSeminar/config/WebConfig.java b/...t/org/fourthSeminar/config/WebConfig.java → .../org/seventhSeminar/config/WebConfig.java
@@ -1,10 +1,10 @@
-package sopt.org.fourthSeminar.config;
+package sopt.org.seventhSeminar.config;
 
 import lombok.RequiredArgsConstructor;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.web.method.support.HandlerMethodArgumentResolver;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
-import sopt.org.fourthSeminar.config.resolver.UserIdResolver;
+import sopt.org.seventhSeminar.config.resolver.UserIdResolver;
 
 import java.util.List;
 

diff --git a/...fourthSeminar/config/resolver/UserId.java → ...eventhSeminar/config/resolver/UserId.java b/...fourthSeminar/config/resolver/UserId.java → ...eventhSeminar/config/resolver/UserId.java
@@ -1,4 +1,4 @@
-package sopt.org.fourthSeminar.config.resolver;
+package sopt.org.seventhSeminar.config.resolver;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;

diff --git a/...minar/config/resolver/UserIdResolver.java → ...minar/config/resolver/UserIdResolver.java b/...minar/config/resolver/UserIdResolver.java → ...minar/config/resolver/UserIdResolver.java
@@ -1,4 +1,4 @@
-package sopt.org.fourthSeminar.config.resolver;
+package sopt.org.seventhSeminar.config.resolver;
 
 import lombok.RequiredArgsConstructor;
 import org.springframework.core.MethodParameter;
@@ -7,7 +7,7 @@
 import org.springframework.web.context.request.NativeWebRequest;
 import org.springframework.web.method.support.HandlerMethodArgumentResolver;
 import org.springframework.web.method.support.ModelAndViewContainer;
-import sopt.org.fourthSeminar.service.JwtService;
+import sopt.org.seventhSeminar.service.JwtService;
 
 import javax.servlet.http.HttpServletRequest;
 import javax.validation.constraints.NotNull;
@@ -26,7 +26,8 @@ public boolean supportsParameter(MethodParameter parameter) {
     @Override
     public Object resolveArgument(@NotNull MethodParameter parameter, ModelAndViewContainer modelAndViewContainer, @NotNull NativeWebRequest webRequest, WebDataBinderFactory binderFactory) {
         final HttpServletRequest request = (HttpServletRequest) webRequest.getNativeRequest();
-        final String token = request.getHeader("Authorization");
+        final String token = request.getHeader("Authorization").split(" ")[1];
+        System.out.println("Authorization = " + request.getHeader("Authorization"));
 
         // 토큰 검증
         if (!jwtService.verifyToken(token)) {

diff --git a/...Seminar/config/swagger/SwaggerConfig.java → ...Seminar/config/swagger/SwaggerConfig.java b/...Seminar/config/swagger/SwaggerConfig.java → ...Seminar/config/swagger/SwaggerConfig.java
@@ -1,12 +1,20 @@
-package sopt.org.fourthSeminar.config.swagger;
+package sopt.org.seventhSeminar.config.swagger;
 
+import io.swagger.v3.oas.annotations.enums.SecuritySchemeType;
+import io.swagger.v3.oas.annotations.security.SecurityScheme;
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.info.Info;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
 @Configuration
+@SecurityScheme(
+        name = "JWT Auth",
+        type = SecuritySchemeType.HTTP,
+        bearerFormat = "JWT",
+        scheme = "bearer"
+)
 public class SwaggerConfig {
 
     @Bean

diff --git a/...thSeminar/controller/BoardController.java → ...thSeminar/controller/BoardController.java b/...thSeminar/controller/BoardController.java → ...thSeminar/controller/BoardController.java
@@ -1,23 +1,24 @@
-package sopt.org.fourthSeminar.controller;
+package sopt.org.seventhSeminar.controller;
 
+import io.swagger.v3.oas.annotations.security.SecurityRequirement;
 import lombok.AccessLevel;
 import lombok.RequiredArgsConstructor;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.web.bind.annotation.*;
-import sopt.org.fourthSeminar.aws.S3Service;
-import sopt.org.fourthSeminar.config.resolver.UserId;
-import sopt.org.fourthSeminar.controller.common.dto.ApiResponse;
-import sopt.org.fourthSeminar.controller.dto.request.BoardImageListRequestDto;
-import sopt.org.fourthSeminar.controller.dto.request.BoardRequestDto;
-import sopt.org.fourthSeminar.controller.exception.Success;
-import sopt.org.fourthSeminar.service.BoardService;
-import sopt.org.fourthSeminar.service.JwtService;
+import sopt.org.seventhSeminar.aws.S3Service;
+import sopt.org.seventhSeminar.config.resolver.UserId;
+import sopt.org.seventhSeminar.controller.common.dto.ApiResponse;
+import sopt.org.seventhSeminar.controller.dto.request.BoardImageListRequestDto;
+import sopt.org.seventhSeminar.controller.exception.Success;
+import sopt.org.seventhSeminar.service.BoardService;
+import sopt.org.seventhSeminar.service.JwtService;
 
 import javax.validation.Valid;
 import java.util.List;
 
 @RestController
+@SecurityRequirement(name = "JWT Auth")
 @RequiredArgsConstructor(access = AccessLevel.PROTECTED)
 @RequestMapping("/board")
 public class BoardController {

diff --git a/...r/controller/ServerProfileController.java → ...r/controller/ServerProfileController.java b/...r/controller/ServerProfileController.java → ...r/controller/ServerProfileController.java
@@ -1,8 +1,7 @@
-package sopt.org.fourthSeminar.controller;
+package sopt.org.seventhSeminar.controller;
 
 
 import lombok.AccessLevel;
-import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 import org.springframework.core.env.Environment;
 import org.springframework.web.bind.annotation.GetMapping;

diff --git a/...rthSeminar/controller/UserController.java → ...nthSeminar/controller/UserController.java b/...rthSeminar/controller/UserController.java → ...nthSeminar/controller/UserController.java
@@ -1,17 +1,18 @@
-package sopt.org.fourthSeminar.controller;
+package sopt.org.seventhSeminar.controller;
 
 
+import io.swagger.v3.oas.annotations.Operation;
 import lombok.AccessLevel;
 import lombok.RequiredArgsConstructor;
 import org.springframework.http.HttpStatus;
 import org.springframework.web.bind.annotation.*;
-import sopt.org.fourthSeminar.controller.common.dto.ApiResponse;
-import sopt.org.fourthSeminar.controller.dto.request.UserLoginRequestDto;
-import sopt.org.fourthSeminar.controller.dto.request.UserRequestDto;
-import sopt.org.fourthSeminar.controller.dto.response.UserLoginResponseDto;
-import sopt.org.fourthSeminar.controller.dto.response.UserResponseDto;
-import sopt.org.fourthSeminar.controller.exception.Success;
-import sopt.org.fourthSeminar.service.UserService;
+import sopt.org.seventhSeminar.controller.common.dto.ApiResponse;
+import sopt.org.seventhSeminar.controller.dto.request.UserLoginRequestDto;
+import sopt.org.seventhSeminar.controller.dto.request.UserRequestDto;
+import sopt.org.seventhSeminar.controller.dto.response.UserLoginResponseDto;
+import sopt.org.seventhSeminar.controller.dto.response.UserResponseDto;
+import sopt.org.seventhSeminar.controller.exception.Success;
+import sopt.org.seventhSeminar.service.UserService;
 
 import javax.validation.Valid;
 
@@ -24,12 +25,14 @@ public class UserController {
 
     @PostMapping("/signup")
     @ResponseStatus(HttpStatus.CREATED)
+    @Operation(summary = "유저 회원가입 API", description = "유저가 서버에 회원가입을 요청합니다.")
     public ApiResponse<UserResponseDto> create(@RequestBody @Valid final UserRequestDto request) {
         return ApiResponse.success(Success.SIGNUP_SUCCESS, userService.create(request));
     }
 
     @GetMapping("/login")
     @ResponseStatus(HttpStatus.OK)
+    @Operation(summary = "유저 로그인 API", description = "유저가 서버에 로그인을 요청합니다.")
     public ApiResponse<UserLoginResponseDto> login(@RequestBody @Valid final UserLoginRequestDto request) {
         return ApiResponse.success(Success.LOGIN_SUCCESS, userService.login(request));
     }

diff --git a/...mon/advice/ControllerExceptionAdvice.java → ...mon/advice/ControllerExceptionAdvice.java b/...mon/advice/ControllerExceptionAdvice.java → ...mon/advice/ControllerExceptionAdvice.java
@@ -1,4 +1,4 @@
-package sopt.org.fourthSeminar.controller.common.advice;
+package sopt.org.seventhSeminar.controller.common.advice;
 
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
@@ -7,9 +7,9 @@
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.ResponseStatus;
 import org.springframework.web.bind.annotation.RestControllerAdvice;
-import sopt.org.fourthSeminar.controller.common.dto.ApiResponse;
-import sopt.org.fourthSeminar.controller.exception.model.SoptException;
-import sopt.org.fourthSeminar.controller.exception.Error;
+import sopt.org.seventhSeminar.controller.common.dto.ApiResponse;
+import sopt.org.seventhSeminar.controller.exception.model.SoptException;
+import sopt.org.seventhSeminar.controller.exception.Error;
 
 import java.util.Objects;
 

diff --git a/...ar/controller/common/dto/ApiResponse.java → ...ar/controller/common/dto/ApiResponse.java b/...ar/controller/common/dto/ApiResponse.java → ...ar/controller/common/dto/ApiResponse.java
@@ -1,11 +1,11 @@
-package sopt.org.fourthSeminar.controller.common.dto;
+package sopt.org.seventhSeminar.controller.common.dto;
 
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
-import sopt.org.fourthSeminar.controller.exception.Error;
-import sopt.org.fourthSeminar.controller.exception.Success;
+import sopt.org.seventhSeminar.controller.exception.Error;
+import sopt.org.seventhSeminar.controller.exception.Success;
 
 @Getter
 @RequiredArgsConstructor(access = AccessLevel.PRIVATE)

diff --git a/...dto/request/BoardImageListRequestDto.java → ...dto/request/BoardImageListRequestDto.java b/...dto/request/BoardImageListRequestDto.java → ...dto/request/BoardImageListRequestDto.java
@@ -1,4 +1,4 @@
-package sopt.org.fourthSeminar.controller.dto.request;
+package sopt.org.seventhSeminar.controller.dto.request;
 
 import lombok.*;
 import org.springframework.web.multipart.MultipartFile;

diff --git a/...ntroller/dto/request/BoardRequestDto.java → ...ntroller/dto/request/BoardRequestDto.java b/...ntroller/dto/request/BoardRequestDto.java → ...ntroller/dto/request/BoardRequestDto.java
@@ -1,4 +1,4 @@
-package sopt.org.fourthSeminar.controller.dto.request;
+package sopt.org.seventhSeminar.controller.dto.request;
 
 
 import lombok.AccessLevel;
@@ -7,7 +7,6 @@
 import lombok.NoArgsConstructor;
 import org.springframework.web.multipart.MultipartFile;
 
-import javax.validation.constraints.Email;
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.NotNull;
 

diff --git a/...ller/dto/request/UserLoginRequestDto.java → ...ller/dto/request/UserLoginRequestDto.java b/...ller/dto/request/UserLoginRequestDto.java → ...ller/dto/request/UserLoginRequestDto.java
@@ -1,4 +1,4 @@
-package sopt.org.fourthSeminar.controller.dto.request;
+package sopt.org.seventhSeminar.controller.dto.request;
 
 import lombok.AccessLevel;
 import lombok.Getter;

diff --git a/...ontroller/dto/request/UserRequestDto.java → ...ontroller/dto/request/UserRequestDto.java b/...ontroller/dto/request/UserRequestDto.java → ...ontroller/dto/request/UserRequestDto.java
@@ -1,4 +1,4 @@
-package sopt.org.fourthSeminar.controller.dto.request;
+package sopt.org.seventhSeminar.controller.dto.request;
 
 import lombok.AccessLevel;
 import lombok.Getter;

diff --git a/...er/dto/response/UserLoginResponseDto.java → ...er/dto/response/UserLoginResponseDto.java b/...er/dto/response/UserLoginResponseDto.java → ...er/dto/response/UserLoginResponseDto.java
@@ -1,4 +1,4 @@
-package sopt.org.fourthSeminar.controller.dto.response;
+package sopt.org.seventhSeminar.controller.dto.response;
 
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;

diff --git a/...troller/dto/response/UserResponseDto.java → ...troller/dto/response/UserResponseDto.java b/...troller/dto/response/UserResponseDto.java → ...troller/dto/response/UserResponseDto.java
@@ -1,4 +1,4 @@
-package sopt.org.fourthSeminar.controller.dto.response;
+package sopt.org.seventhSeminar.controller.dto.response;
 
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;

diff --git a/...thSeminar/controller/exception/Error.java → ...thSeminar/controller/exception/Error.java b/...thSeminar/controller/exception/Error.java → ...thSeminar/controller/exception/Error.java
@@ -1,4 +1,4 @@
-package sopt.org.fourthSeminar.controller.exception;
+package sopt.org.seventhSeminar.controller.exception;
 
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;

diff --git a/...nar/controller/exception/ErrorStatus.java → ...nar/controller/exception/ErrorStatus.java b/...nar/controller/exception/ErrorStatus.java → ...nar/controller/exception/ErrorStatus.java
@@ -1,4 +1,4 @@
-package sopt.org.fourthSeminar.controller.exception;
+package sopt.org.seventhSeminar.controller.exception;
 
 
 import lombok.AccessLevel;

diff --git a/...Seminar/controller/exception/Success.java → ...Seminar/controller/exception/Success.java b/...Seminar/controller/exception/Success.java → ...Seminar/controller/exception/Success.java
@@ -1,4 +1,4 @@
-package sopt.org.fourthSeminar.controller.exception;
+package sopt.org.seventhSeminar.controller.exception;
 
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;

diff --git a/...r/controller/exception/SuccessStatus.java → ...r/controller/exception/SuccessStatus.java b/...r/controller/exception/SuccessStatus.java → ...r/controller/exception/SuccessStatus.java
@@ -1,4 +1,4 @@
-package sopt.org.fourthSeminar.controller.exception;
+package sopt.org.seventhSeminar.controller.exception;
 
 import lombok.AccessLevel;
 import lombok.Getter;

diff --git a/.../exception/model/BadRequestException.java → .../exception/model/BadRequestException.java b/.../exception/model/BadRequestException.java → .../exception/model/BadRequestException.java
@@ -1,6 +1,6 @@
-package sopt.org.fourthSeminar.controller.exception.model;
+package sopt.org.seventhSeminar.controller.exception.model;
 
-import sopt.org.fourthSeminar.controller.exception.Error;
+import sopt.org.seventhSeminar.controller.exception.Error;
 
 public class BadRequestException extends SoptException{
 

diff --git a/...er/exception/model/ConflictException.java → ...er/exception/model/ConflictException.java b/...er/exception/model/ConflictException.java → ...er/exception/model/ConflictException.java
@@ -1,6 +1,6 @@
-package sopt.org.fourthSeminar.controller.exception.model;
+package sopt.org.seventhSeminar.controller.exception.model;
 
-import sopt.org.fourthSeminar.controller.exception.Error;
+import sopt.org.seventhSeminar.controller.exception.Error;
 
 public class ConflictException extends SoptException {
     public ConflictException(Error error, String message) {

diff --git a/...er/exception/model/NotFoundException.java → ...er/exception/model/NotFoundException.java b/...er/exception/model/NotFoundException.java → ...er/exception/model/NotFoundException.java
@@ -1,7 +1,7 @@
-package sopt.org.fourthSeminar.controller.exception.model;
+package sopt.org.seventhSeminar.controller.exception.model;
 
 
-import sopt.org.fourthSeminar.controller.exception.Error;
+import sopt.org.seventhSeminar.controller.exception.Error;
 
 public class NotFoundException extends SoptException {
     public NotFoundException(Error error, String message) {

diff --git a/...roller/exception/model/SoptException.java → ...roller/exception/model/SoptException.java b/...roller/exception/model/SoptException.java → ...roller/exception/model/SoptException.java
@@ -1,7 +1,7 @@
-package sopt.org.fourthSeminar.controller.exception.model;
+package sopt.org.seventhSeminar.controller.exception.model;
 
 import lombok.Getter;
-import sopt.org.fourthSeminar.controller.exception.Error;
+import sopt.org.seventhSeminar.controller.exception.Error;
 
 @Getter
 public class SoptException extends RuntimeException {

diff --git a/...xception/model/UnauthorizedException.java → ...xception/model/UnauthorizedException.java b/...xception/model/UnauthorizedException.java → ...xception/model/UnauthorizedException.java
@@ -1,6 +1,6 @@
-package sopt.org.fourthSeminar.controller.exception.model;
+package sopt.org.seventhSeminar.controller.exception.model;
 
-import sopt.org.fourthSeminar.controller.exception.Error;
+import sopt.org.seventhSeminar.controller.exception.Error;
 
 public class UnauthorizedException extends SoptException{
     public UnauthorizedException(Error error, String message) {

diff --git a/.../sopt/org/fourthSeminar/domain/Board.java → ...sopt/org/seventhSeminar/domain/Board.java b/.../sopt/org/fourthSeminar/domain/Board.java → ...sopt/org/seventhSeminar/domain/Board.java
@@ -1,9 +1,9 @@
-package sopt.org.fourthSeminar.domain;
+package sopt.org.seventhSeminar.domain;
 
 import lombok.AccessLevel;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
-import sopt.org.fourthSeminar.AuditingTimeEntity;
+import sopt.org.seventhSeminar.AuditingTimeEntity;
 
 import javax.persistence.*;
 

diff --git a/.../sopt/org/fourthSeminar/domain/Image.java → ...sopt/org/seventhSeminar/domain/Image.java b/.../sopt/org/fourthSeminar/domain/Image.java → ...sopt/org/seventhSeminar/domain/Image.java
@@ -1,9 +1,9 @@
-package sopt.org.fourthSeminar.domain;
+package sopt.org.seventhSeminar.domain;
 
 import lombok.AccessLevel;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
-import sopt.org.fourthSeminar.AuditingTimeEntity;
+import sopt.org.seventhSeminar.AuditingTimeEntity;
 
 import javax.persistence.*;
 

diff --git a/...a/sopt/org/fourthSeminar/domain/User.java → .../sopt/org/seventhSeminar/domain/User.java b/...a/sopt/org/fourthSeminar/domain/User.java → .../sopt/org/seventhSeminar/domain/User.java
@@ -1,10 +1,10 @@
-package sopt.org.fourthSeminar.domain;
+package sopt.org.seventhSeminar.domain;
 
 import lombok.AccessLevel;
 import lombok.Builder;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
-import sopt.org.fourthSeminar.AuditingTimeEntity;
+import sopt.org.seventhSeminar.AuditingTimeEntity;
 
 import javax.persistence.*;
 

diff --git a/...minar/infrastructure/BoardRepository.java → ...minar/infrastructure/BoardRepository.java b/...minar/infrastructure/BoardRepository.java → ...minar/infrastructure/BoardRepository.java
@@ -1,7 +1,7 @@
-package sopt.org.fourthSeminar.infrastructure;
+package sopt.org.seventhSeminar.infrastructure;
 
 import org.springframework.data.repository.Repository;
-import sopt.org.fourthSeminar.domain.Board;
+import sopt.org.seventhSeminar.domain.Board;
 
 public interface BoardRepository extends Repository<Board, Long> {
 

diff --git a/...minar/infrastructure/ImageRepository.java → ...minar/infrastructure/ImageRepository.java b/...minar/infrastructure/ImageRepository.java → ...minar/infrastructure/ImageRepository.java
@@ -1,8 +1,8 @@
-package sopt.org.fourthSeminar.infrastructure;
+package sopt.org.seventhSeminar.infrastructure;
 
 
 import org.springframework.data.repository.Repository;
-import sopt.org.fourthSeminar.domain.Image;
+import sopt.org.seventhSeminar.domain.Image;
 
 public interface ImageRepository extends Repository<Image, Long> {
     // CREATE

diff --git a/...eminar/infrastructure/UserRepository.java → ...eminar/infrastructure/UserRepository.java b/...eminar/infrastructure/UserRepository.java → ...eminar/infrastructure/UserRepository.java
@@ -1,7 +1,7 @@
-package sopt.org.fourthSeminar.infrastructure;
+package sopt.org.seventhSeminar.infrastructure;
 
 import org.springframework.data.repository.Repository;
-import sopt.org.fourthSeminar.domain.User;
+import sopt.org.seventhSeminar.domain.User;
 
 import java.util.Optional;