[미소] 클론코딩 프로젝트 2-3) 이용자 서비스 API 설계 - 회원 로그인

2023.08.10 - [초기 과업/BackEnd] - [미소] 클론코딩 프로젝트 2-2) 이용자 서비스 API 설계 - 회원가입

[미소] 클론코딩 프로젝트 2-2) 이용자 서비스 API 설계 - 회원가입

 

안녕하세요. 기깔나는 사람들에서 백엔드를 맡고 있는 황시아입니다.

 

저번 시간에 회원가입 서비스를 제공하는 API를 설계했으니까 이번에는 가입한 회원에게 로그인 서비스를 제공하는 API를 설계하겠습니다.

 

 

회원 로그인 API

Request

API 호출 방식

요청 URL	메서드
/api/members/auth/signin	POST

 

Request Header

Request Header에 대한 상세는 다음과 같습니다.

파라미터	타입	필수 여부	설명
Content-Type	String	필수	application/json 이어야 함

 

Request Elements

Request Elements에 대한 상세는 다음과 같습니다.

필드	상위 필드	타입	필수 여부	설명
email		String	필수	이메일
password		String	필수	비밀번호

 

Request Syntax

curl -X POST http://{BASE_URL}/api/members/auth/signin \
    -H "Content-Type: application/json;charset=utf-8" \
    -d \
        '{\
            "email": "이메일",\
            "password": "비밀번호"\
         }'

 

 

Response

Response Elements

Response Elements에 대한 상세는 다음과 같습니다.

필드	상위 필드	타입	필수 여부	설명
statusCode		Integer	필수	API 공통 가이드 - 공통 Response 참조
message		String	필수	API 공통 가이드 - 공통 Response 참조
data		Object	필수	토큰 정보
accessToken	data	String	필수	회원 서비스 접근시 인증에 사용될 토큰
refreshToken	data	String	필수	액세스 토큰 갱신에 사용될 토큰
accessTokenExpiresIn	data	Integer	필수	액세스 토큰 만료 시간(초)

 

Response Syntax

{
    "statusCode": 200,
    "message": "성공",
    "data": {
        "accessToken" : "",
        "refreshToken" : "",
        "accessTokenExpiresIn": "1800"
    },
}