API 문서

회원가입

HTTP 요청

회원가입 요청에 대한 설명입니다.

HTTP Request

POST /api/v1/members/join HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 111
Host: localhost:8080

{
  "email" : "email@example.com",
  "name" : "이름",
  "nickname" : "닉네임",
  "password" : "password"
}

Request Headers

Request Body

{
  "email" : "email@example.com",
  "name" : "이름",
  "nickname" : "닉네임",
  "password" : "password"
}

Request Fields

Path Type Description

Path	Type	Description
`email`	`String`	이메일
`name`	`String`	이름
`nickname`	`String`	닉네임
`password`	`String`	비밀번호

email

String

이메일

name

String

이름

nickname

String

닉네임

password

String

비밀번호

HTTP 성공 응답

회원가입 성공 시 반환되는 응답입니다.

HTTP Response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: /api/v1/members/6a968568-f83c-45e0-8315-26166fe10a35
Content-Type: application/json
Content-Length: 246

{
  "message" : "회원가입이 성공적으로 이루어졌습니다.",
  "code" : "0",
  "data" : {
    "id" : "6a968568-f83c-45e0-8315-26166fe10a35",
    "name" : "이름",
    "nickname" : "닉네임",
    "email" : "email@example.com"
  }
}

Response Headers

Name Description

Name	Description
`Location`	생성된 리소스의 URI

Location

생성된 리소스의 URI

Response Body

{
  "message" : "회원가입이 성공적으로 이루어졌습니다.",
  "code" : "0",
  "data" : {
    "id" : "6a968568-f83c-45e0-8315-26166fe10a35",
    "name" : "이름",
    "nickname" : "닉네임",
    "email" : "email@example.com"
  }
}

Response Fields

Path Type Description

Path	Type	Description
`code`	`String`	성공 코드
`message`	`String`	성공 메시지
`data`	`Object`	응답 값
`data.id`	`String`	회원 ID
`data.name`	`String`	회원 이름
`data.nickname`	`String`	회원 닉네임
`data.email`	`String`	회원 이메일

code

String

성공 코드

message

String

성공 메시지

data

Object

응답 값

data.id

String

회원 ID

data.name

String

회원 이름

data.nickname

String

회원 닉네임

data.email

String

회원 이메일

HTTP 실패 응답

회원가입 실패 시 발생할 수 있는 오류들을 분류하여 설명합니다.

유효성 오류

회원가입 요청 데이터의 유효성 검사 실패 응답입니다.

이메일 유효성 오류

회원가입 시 이메일이 유효성 검사에 실패하는 경우 발생하는 오류입니다.

blank

{
  "message" : "요청 데이터를 모두 올바르게 입력했는지 확인해 주세요.",
  "code" : "C_001",
  "errors" : [ {
    "field" : "email",
    "value" : "",
    "reason" : "이메일은 필수입니다."
  } ]
}

null

{
  "message" : "요청 데이터를 모두 올바르게 입력했는지 확인해 주세요.",
  "code" : "C_001",
  "errors" : [ {
    "field" : "email",
    "value" : "",
    "reason" : "이메일은 필수입니다."
  } ]
}

pattern

{
  "message" : "요청 데이터를 모두 올바르게 입력했는지 확인해 주세요.",
  "code" : "C_001",
  "errors" : [ {
    "field" : "email",
    "value" : "invalid-email",
    "reason" : "이메일을 형식에 맞게 입력해 주세요."
  } ]
}

size

{
  "message" : "요청 데이터를 모두 올바르게 입력했는지 확인해 주세요.",
  "code" : "C_001",
  "errors" : [ {
    "field" : "email",
    "value" : "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa@example.com",
    "reason" : "이메일을 50자 이하로 입력해 주세요."
  } ]
}

이름 유효성 오류

회원가입 시 이름이 유효성 검사에 실패하는 경우 발생하는 오류입니다.

blank

{
  "message" : "요청 데이터를 모두 올바르게 입력했는지 확인해 주세요.",
  "code" : "C_001",
  "errors" : [ {
    "field" : "name",
    "value" : "",
    "reason" : "이름은 필수입니다."
  } ]
}

null

{
  "message" : "요청 데이터를 모두 올바르게 입력했는지 확인해 주세요.",
  "code" : "C_001",
  "errors" : [ {
    "field" : "name",
    "value" : "",
    "reason" : "이름은 필수입니다."
  } ]
}

size

{
  "message" : "요청 데이터를 모두 올바르게 입력했는지 확인해 주세요.",
  "code" : "C_001",
  "errors" : [ {
    "field" : "name",
    "value" : "aaaaaaaaaaaaaaaaaaaaa",
    "reason" : "이름을 20자 이하로 입력해 주세요."
  } ]
}

닉네임 유효성 오류

회원가입 시 닉네임이 유효성 검사에 실패하는 경우 발생하는 오류입니다.

blank

{
  "message" : "요청 데이터를 모두 올바르게 입력했는지 확인해 주세요.",
  "code" : "C_001",
  "errors" : [ {
    "field" : "nickname",
    "value" : "",
    "reason" : "닉네임은 필수입니다."
  } ]
}

null

{
  "message" : "요청 데이터를 모두 올바르게 입력했는지 확인해 주세요.",
  "code" : "C_001",
  "errors" : [ {
    "field" : "nickname",
    "value" : "",
    "reason" : "닉네임은 필수입니다."
  } ]
}

size

{
  "message" : "요청 데이터를 모두 올바르게 입력했는지 확인해 주세요.",
  "code" : "C_001",
  "errors" : [ {
    "field" : "nickname",
    "value" : "aaaaaaaaaaaaaaaaaaaaa",
    "reason" : "닉네임을 20자 이하로 입력해 주세요."
  } ]
}

비밀번호 유효성 오류

회원가입 시 비밀번호가 유효성 검사에 실패하는 경우 발생하는 오류입니다.

blank

{
  "message" : "요청 데이터를 모두 올바르게 입력했는지 확인해 주세요.",
  "code" : "C_001",
  "errors" : [ {
    "field" : "password",
    "value" : "",
    "reason" : "비밀번호는 필수입니다."
  } ]
}

null

{
  "message" : "요청 데이터를 모두 올바르게 입력했는지 확인해 주세요.",
  "code" : "C_001",
  "errors" : [ {
    "field" : "password",
    "value" : "",
    "reason" : "비밀번호는 필수입니다."
  } ]
}

size

{
  "message" : "요청 데이터를 모두 올바르게 입력했는지 확인해 주세요.",
  "code" : "C_001",
  "errors" : [ {
    "field" : "password",
    "value" : "aaaaaaaaaaaaaaaaaaaaa",
    "reason" : "비밀번호를 20자 이하로 입력해 주세요."
  } ]
}

중복 오류

회원가입 요청 데이터의 중복 예외로 인한 실패 응답입니다.

이메일 중복 오류

회원가입 시 이메일이 이미 존재하는 경우 발생하는 오류입니다.

{
  "message" : "이미 가입된 계정입니다.",
  "code" : "AJ_001"
}

닉네임 중복 오류

회원가입 시 닉네임이 이미 존재하는 경우 발생하는 오류입니다.

{
  "message" : "사용 중인 닉네임입니다.",
  "code" : "AJ_002"
}

Path	Type	Description
`email`	`String`	이메일
`password`	`String`	비밀번호

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 243

{
  "message" : "로그인이 성공적으로 이루어졌습니다.",
  "code" : "0",
  "data" : {
    "id" : "5632867e-712c-482b-a21a-f3bc74471c91",
    "email" : "email@example.com",
    "name" : "이름",
    "nickname" : "닉네임"
  }
}

Response Header

Response Body

{
  "message" : "로그인이 성공적으로 이루어졌습니다.",
  "code" : "0",
  "data" : {
    "id" : "5632867e-712c-482b-a21a-f3bc74471c91",
    "email" : "email@example.com",
    "name" : "이름",
    "nickname" : "닉네임"
  }
}

Response Fields

Path Type Description

Path	Type	Description
`code`	`String`	성공 코드
`message`	`String`	성공 메시지
`data`	`Object`	응답 값
`data.id`	`String`	회원 ID
`data.name`	`String`	회원 이름
`data.nickname`	`String`	회원 닉네임
`data.email`	`String`	회원 이메일

code

String

성공 코드

message

String

성공 메시지

data

Object

응답 값

data.id

String

회원 ID

data.name

String

회원 이름

data.nickname

String

회원 닉네임

data.email

String

회원 이메일

HTTP 실패 응답

로그인 실패 시 발생할 수 있는 오류들을 분류하여 설명합니다.

유효성 오류

로그인 요청 데이터의 유효성 검사 실패 응답입니다.

이메일 유효성 오류

로그인 시 이메일이 유효성 검사에 실패하는 경우 발생하는 오류입니다.

blank

{
  "message" : "요청 데이터를 모두 올바르게 입력했는지 확인해 주세요.",
  "code" : "C_001",
  "errors" : [ {
    "field" : "email",
    "value" : "",
    "reason" : "이메일은 필수입니다."
  } ]
}

null

{
  "message" : "요청 데이터를 모두 올바르게 입력했는지 확인해 주세요.",
  "code" : "C_001",
  "errors" : [ {
    "field" : "email",
    "value" : "",
    "reason" : "이메일은 필수입니다."
  } ]
}

pattern

{
  "message" : "요청 데이터를 모두 올바르게 입력했는지 확인해 주세요.",
  "code" : "C_001",
  "errors" : [ {
    "field" : "email",
    "value" : "invalid-email",
    "reason" : "must be a well-formed email address"
  } ]
}

size

{
  "message" : "요청 데이터를 모두 올바르게 입력했는지 확인해 주세요.",
  "code" : "C_001",
  "errors" : [ {
    "field" : "email",
    "value" : "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa@example.com",
    "reason" : "이메일은 1자 이상 50자 이하로 입력해 주세요."
  } ]
}

비밀번호 유효성 오류

로그인 시 비밀번호가 유효성 검사에 실패하는 경우 발생하는 오류입니다.

blank

{
  "message" : "요청 데이터를 모두 올바르게 입력했는지 확인해 주세요.",
  "code" : "C_001",
  "errors" : [ {
    "field" : "password",
    "value" : "",
    "reason" : "비밀번호는 필수입니다."
  } ]
}

null

{
  "message" : "요청 데이터를 모두 올바르게 입력했는지 확인해 주세요.",
  "code" : "C_001",
  "errors" : [ {
    "field" : "password",
    "value" : "",
    "reason" : "비밀번호는 필수입니다."
  } ]
}

size

{
  "message" : "요청 데이터를 모두 올바르게 입력했는지 확인해 주세요.",
  "code" : "C_001",
  "errors" : [ {
    "field" : "password",
    "value" : "aaaaaaaaaaaaaaaaaaaaa",
    "reason" : "비밀번호는 1자 이상 50자 이하로 입력해 주세요."
  } ]
}