Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

로그인 API Swagger 반영 #16

Merged
merged 2 commits into from
Mar 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
package org.interviewmate.domain.auth.api;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.interviewmate.domain.auth.dto.LoginReq;
import org.interviewmate.domain.auth.dto.LoginRes;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@Tag(name = "인증 관련 API")
@RestController
@RequestMapping("/auth")
@RequiredArgsConstructor
public class AuthApiController {

@Operation(summary = "로그인 API", description = "필요한 정보를 받아 로그인 진행")
@PostMapping("/login")
public LoginRes signUp(@RequestBody LoginReq loginReq) {
return null;
}

}
16 changes: 16 additions & 0 deletions src/main/java/org/interviewmate/domain/auth/dto/LoginReq.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
package org.interviewmate.domain.auth.dto;

import io.swagger.v3.oas.annotations.media.Schema;
import java.util.List;
import lombok.Getter;

@Schema(name = "로그인 Request", description = "로그인에 필요한 정보")
@Getter
public class LoginReq {

@Schema(description = "이메일", example = "[email protected]")
private String email;
@Schema(description = "비밀번호", example = "Moamoa0302!")
private String password;

}
18 changes: 18 additions & 0 deletions src/main/java/org/interviewmate/domain/auth/dto/LoginRes.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
package org.interviewmate.domain.auth.dto;

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Getter;

@Schema(name = "로그인 Response", description = "로그인 결과에 대한 정보")
@Getter
public class LoginRes {

@Schema(description = "유저 식별자", example = "1")
private Long userId;
@Schema(description = "Access 토큰", example = "eyJ0eXBlIjoiand0IiwiYWxnIjoiSFMyNTYifQ.eyJpYXQiOjE2Nzk1NjYzOTEsImV4cCI6MTY3OTU2ODE5MSwidXNlcklkeCI6MjB9.-Ji4Cw5S8qGbCrNs9MlEyqACEIYH6qZKSsJRobFzY_w")
private String accessToken;
@Schema(description = "Refresh 토큰", example = "eyJ0eXBlIjoiand0IiwiYWxnIjoiSFMyNTYifQ.eyJpYXQiOjE2Nzk1NjYzOTEsImV4cCI6MTY4MDE3MTE5MX0.cRQqbqLYsbVfYUMj7WQd-IlhMl_-pEC-BOYrIA0TNPc")
private String refreshToken;


}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
package org.interviewmate.domain.user.api;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.interviewmate.domain.user.dto.PostUserReq;
import org.interviewmate.domain.user.dto.PostUserRes;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@Tag(name = "유저 관련 API")
@RestController
@RequestMapping("/users")
@RequiredArgsConstructor
public class UserApiController {

@Operation(summary = "회원 가입 API", description = "필요한 정보를 받아 회원 가입 진행")
@PostMapping("/sign-up")
public PostUserRes signUp(@RequestBody PostUserReq postUserReq) {
return null;
}

}
25 changes: 25 additions & 0 deletions src/main/java/org/interviewmate/domain/user/dto/PostUserReq.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
package org.interviewmate.domain.user.dto;

import io.swagger.v3.oas.annotations.media.Schema;
import java.util.List;
import lombok.Getter;

@Schema(name = "회원 가입 Request", description = "회원 가입에 필요한 유저에 대한 정보")
@Getter
public class PostUserReq {

@Schema(description = "이메일", example = "[email protected]")
private String email;
@Schema(description = "비밀번호", example = "Moamoa0302!")
private String password;

@Schema(description = "닉네임", example = "모아모아뀽")
private String nickName;

@Schema(description = "직무", example = "서버 개발자")
private String job;

@Schema(description = "키워드", example = "{Spring, JPA, Java}")
private List<String> keyword;

}
17 changes: 17 additions & 0 deletions src/main/java/org/interviewmate/domain/user/dto/PostUserRes.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
package org.interviewmate.domain.user.dto;

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Getter;

@Schema(name = "회원 가입 Response", description = "회원 가입을 완료한 유저에 대한 정보")
@Getter
public class PostUserRes {

@Schema(description = "유저 식별자", example = "1")
private Long userId;
@Schema(description = "이메일", example = "[email protected]")
private String email;
@Schema(description = "비밀번호", example = "Moamoa0302!")
private String password;

}