🚀 API

공통 headers

Name	Description	optional
access_token	JWT accessToken
refresh_token	JWT refreshToken (accessToken이 만료된 경우, 재발급 용도로 사용)

Name

Description

optional

access_token

JWT accessToken

refresh_token

JWT refreshToken (accessToken이 만료된 경우, 재발급 용도로 사용)

공통 ResponseCode

Code	Description
SUCCESS	success.
INVALID_TOKEN_ERROR	invalid token error occurred.
WRONG_PASSWORD_ERROR	wrong password error occurred.
ALREADY_LOGOUT_ERROR	already logout error occurred.
AUTH_ERROR	auth error occurred.
ACCESS_DENIED_ERROR	access denied error occurred.
EXIST_MEMBER	already member error occurred.
UNKNOWN_ERROR	unknown error occurred.
MANUAL_ERROR	manual error occurred.
NOT_FOUNT_ERROR	not found error occurred.
INVALID_REQUEST_PARAM	invalid request parameter error occurred.
ENCRYPT_ERROR	encrypt error occurred
DECRYPT_ERROR	decrypt error occurred

Code

Description

SUCCESS

success.

INVALID_TOKEN_ERROR

invalid token error occurred.

WRONG_PASSWORD_ERROR

wrong password error occurred.

ALREADY_LOGOUT_ERROR

already logout error occurred.

AUTH_ERROR

auth error occurred.

ACCESS_DENIED_ERROR

access denied error occurred.

EXIST_MEMBER

already member error occurred.

UNKNOWN_ERROR

unknown error occurred.

MANUAL_ERROR

manual error occurred.

NOT_FOUNT_ERROR

not found error occurred.

INVALID_REQUEST_PARAM

invalid request parameter error occurred.

ENCRYPT_ERROR

encrypt error occurred

DECRYPT_ERROR

decrypt error occurred

유저 API

유저 회원가입

👀 유저 회원가입을 한다.

POST localhost:8080/api/user/join HTTP/1.1

Request

curl

$ curl 'http://localhost:8080/api/user/join' -i -X POST \
    -H 'Content-Type: application/json;charset=utf-8' \
    -H 'Accept: application/json' \
    -H 'access_token: access_token_value' \
    -H 'refresh_token: refresh_token_value' \
    -d '{
  "username" : "test",
  "password" : "test",
  "name" : "test",
  "phoneNumber" : "01011111111"
}'

request body
Depth1	type	Description
name	String	회원 이름
username	String	로그인 ID
password	String	로그인 PWD
phoneNumber	String	회원 전화번호

sample

POST /api/user/join HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 100
Host: localhost:8080
access_token: access_token_value
refresh_token: refresh_token_value

{
  "username" : "test",
  "password" : "test",
  "name" : "test",
  "phoneNumber" : "01011111111"
}

Response

response body
Depth1	Depth2	type	optional	Description
resultCode		String	o	결과 코드
resultMessage		String	o	결과 메세지
body		Object	x	결과
	id	Number	x	회원 SEQ

sample

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 93

{
  "resultCode" : "SUCCESS",
  "resultMessage" : "success.",
  "body" : {
    "id" : 1
  }
}

유저 로그인

👀 유저 로그인을 시도한다.

POST localhost:8080/api/user/login HTTP/1.1

Request

curl

$ curl 'http://localhost:8080/api/user/login' -i -X POST \
    -H 'Content-Type: application/json;charset=utf-8' \
    -H 'Accept: application/json' \
    -H 'access_token: access_token_value' \
    -H 'refresh_token: refresh_token_value' \
    -d '{
  "username" : "test",
  "password" : "test"
}'

request body
Depth1	type	Description	optional
username	String	로그인 ID
password	String	로그인 PWD

sample

POST /api/user/login HTTP/1.1
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: 48
Host: localhost:8080
access_token: access_token_value
refresh_token: refresh_token_value

{
  "username" : "test",
  "password" : "test"
}

Response

response body
Depth1	Depth2	type	optional	Description
resultCode		String	o	결과 코드
resultMessage		String	o	결과 메세지
body		Object	x	결과
	accessToken	String	x	JWT accessToken
	refreshToken	String	x	JWT refreshToken

sample

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 165

{
  "resultCode" : "SUCCESS",
  "resultMessage" : "success.",
  "body" : {
    "accessToken" : "access_token_value",
    "refreshToken" : "refresh_token_value"
  }
}

유저 로그아웃

👀 유저 로그아웃을 한다.

DELETE localhost:8080/api/user/logout HTTP/1.1

Request

curl

$ curl 'http://localhost:8080/api/user/logout' -i -X DELETE \
    -H 'access_token: access_token_value' \
    -H 'refresh_token: refresh_token_value'

sample

DELETE /api/user/logout HTTP/1.1
Host: localhost:8080
access_token: access_token_value
refresh_token: refresh_token_value

Response

response body
Depth1	type	optional	Description
resultCode	String	o	결과 코드
resultMessage	String	o	결과 메세지
body	Null	x	결과

sample

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 79

{
  "resultCode" : "SUCCESS",
  "resultMessage" : "success.",
  "body" : null
}

회원 API

회원 조회(로그인 ID)

👀 로그인 ID로 회원을 조회한다.

GET localhost:8080/api/member/{username} HTTP/1.1

Request

curl

$ curl 'http://localhost:8080/api/member/test' -i -X GET \
    -H 'access_token: access_token_value' \
    -H 'refresh_token: refresh_token_value'

path parameter
Name	Description
username	로그인 ID

sample

GET /api/member/test HTTP/1.1
Host: localhost:8080
access_token: access_token_value
refresh_token: refresh_token_value

Response

response body
Depth1	Depth2	type	optional	Description	format
resultCode		String	o	결과 코드
resultMessage		String	o	결과 메세지
body		Object	x	결과
	id	Number	x	회원 SEQ
	username	String	x	로그인 ID
	name	String	x	회원 이름
	phoneNumber	String	o	회원 전화번호
	createdAt	String	x	회원 생성일자	yyyy-mm-dd HH:mm:ss
	updatedAt	String	x	회원 수정일자	yyyy-mm-dd HH:mm:ss
	imageUrl	String	o	회원 프로필 URL

sample

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 305

{
  "resultCode" : "SUCCESS",
  "resultMessage" : "success.",
  "body" : {
    "id" : 1,
    "username" : "test",
    "name" : "test",
    "phoneNumber" : "01011111111",
    "createdAt" : "2025-02-17T17:59:28.911535",
    "updatedAt" : "2025-02-17T17:59:28.911551",
    "imageUrl" : "https://~~.com"
  }
}