회원가입 - story-dict

Request

Body Params application/json

id

string | null

optional

생성할 유저 식별자

email

string

required

유저 이메일

password

string

required

유저 비밀번호

nickname

string

required

유저 닉네임

phone

string | null

optional

유저 휴대폰 번호

money

integer | null

optional

유저 소지금

>= 0<= 2147483647

Default:

1000

imagePath

string | null

optional

유저 이미지 경로

role

optional

유저 역할

Any of

UserRole

null

유저 역할

Allowed values:

ADMINMANAGERUSERGUEST

Default:

USER

provider

optional

유저 로그인 방식

Any of

UserProvider

null

유저 로그인 방식

Allowed values:

LOCALKAKAOGOOGLE

Default:

LOCAL

providerId

string | null

optional

유저 로그인 방식 식별자

Example

{
  "email": "developer00@sd.com",
  "password": "13579zZ@",
  "nickname": "개발자00",
  "phone": "010-1111-1111"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://localhost:9050/apis/v1/users' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "developer00@sd.com",
    "password": "13579zZ@",
    "nickname": "개발자00",
    "phone": "010-1111-1111"
}'

Responses

🟢201🟢 회원가입 성공

application/json

Body

toast

object (Toast)

required

title

string

required

프론트에서 렌더링할 토스트 메시지 제목

description

string

required

프론트에서 렌더링할 토스트 메시지 내용

payload

object

required

id

string

required

유저 식별자

createdAt

string

required

생성 일자

Default:

CURRENT_TIMESTAMP

updatedAt

string

required

수정 일자

deletedAt

string

optional

삭제 일자

email

string

required

유저 이메일

money

integer

required

유저 소지금

>= 0<= 2147483647

Default:

1000

nickname

string

required

유저 닉네임

phone

string | null

optional

유저 휴대폰 번호

imagePath

string | null

optional

유저 이미지 경로

role

enum<string>

optional

유저 역할

Allowed values:

ADMINMANAGERUSERGUEST

Default:

USER

provider

enum<string>

required

유저 로그인 방식

Allowed values:

LOCALKAKAOGOOGLE

Default:

LOCAL

providerId

string | null

optional

유저 로그인 방식 식별자

Example

{
  "toast": {
    "title": "회원가입 완료",
    "description": "회원가입을 축하드립니다.\n메인 페이지로 이동합니다!"
  },
  "payload": {
    "id": "9a00dad3-628e-449a-a0ae-a442264bf14c",
    "createdAt": "2024-12-11T23:28:36.299Z",
    "updatedAt": "2024-12-11T23:28:36.299Z",
    "deletedAt": null,
    "email": "developer0@sd.com",
    "nickname": "개발자0",
    "phone": "010-1111-1111",
    "money": 1000,
    "imagePath": null,
    "role": "USER",
    "provider": "LOCAL",
    "providerId": null
  }
}

🟠400🔴 유효성 검사 실패

🟠403🔴 권한없음

🟠409🔴 중복된 요청