email 유효성 검증
Endpoint
POST /{api_version}/validate/email
POST Parameters
[
'email' => ['required', 'max:255', 'email', 'unique:users,email'],
]
검증하고자 하는 email 값이며, 아래와 같은 사항을 검증합니다.
- email 필드의 존재 여부 검증
- 길이가 255자 이하인지 검증
- 이메일 형식인지 검증
- users 테이블의 email 칼럼에 저장된 값 중 중복된 값이 있는지 검증
Response Structure
이 Endpoint는 처리 결과에 따라 아래 2가지 응답을 반환합니다.
email 값이 유효하지 않은 경우
HTTP Status Code: 422: Unprocessable Entity
{
"meta": {
"code": 422,
"error_type": "ValidationException",
"error_message": "Unprocessable Entity"
},
"data": {
"email": [
"{에러 메세지.}"
]
}
}
email 값이 유효한 경우
HTTP Status Code: 200: OK
{
"meta": {
"code": 200
},
"data": {
"email": "{검증을 요청한 값}",
"status": "valid"
]
}
}
username 유효성 검증
Endpoint
POST /{api_version}/validate/username
POST Parameters
[
'username' => [
'required',
'max:255',
'regex:/^[ㄱ-ㅎ가-힣A-Za-z0-9]+[ㄱ-ㅎ가-힣A-Za-z0-9-_\.]*[ㄱ-ㅎ가-힣A-Za-z0-9]+$/',
'unique:users,username'
]
]
username
검증하고자 하는 username 값이며, 아래와 같은 사항을 검증합니다.
- username 필드의 존재 여부 검증
- 길이가 255자 이하인지 검증
- 사용자명 정규식 형식과 일치하는지 검증
- users 테이블의 username 칼럼에 저장된 값 중 중복된 값이 있는지 검증
Response Structure
이 Endpoint는 처리 결과에 따라 아래 2가지 응답을 반환합니다.
username 값이 유효하지 않은 경우
HTTP Status Code: 422: Unprocessable Entity
{
"meta": {
"code": 422,
"error_type": "ValidationException",
"error_message": "Unprocessable Entity"
},
"data": {
"username": [
"{에러 메세지.}"
]
}
}
username 값이 유효한 경우
HTTP Status Code: 200: OK
{
"meta": {
"code": 200
},
"data": {
"username": "{검증을 요청한 값}",
"status": "valid"
}
}
Endpoint
POST /{api_version}/validate/slug
POST Parameters
[
'slug' => [
'required',
'min:4',
'max:256',
'regex:/^[A-Za-z0-9]+[A-Za-z0-9-_]*[A-Za-z0-9]+$/',
'unique:users,slug'
]
]
slug
검증하고자 하는 slug 값이며, 아래와 같은 사항을 검증합니다.
- slug 필드의 존재 여부 검증
- 길이가 4자 이상인지 검증
- 길이가 256자 이하인지 검증
- 슬러그 정규식 형식과 일치하는지 검증
- users 테이블의 slug 칼럼에 저장된 값 중 중복된 값이 있는지 검증
Response Structure
이 Endpoint는 처리 결과에 따라 아래 2가지 응답을 반환합니다.
slug 값이 유효하지 않은 경우
HTTP Status Code: 422: Unprocessable Entity
{
"meta": {
"code": 422,
"error_type": "ValidationException",
"error_message": "Unprocessable Entity"
},
"data": {
"username": [
"{에러 메세지.}"
]
}
}
slug 값이 유효한 경우
HTTP Status Code: 200: OK
{
"meta": {
"code": 200
},
"data": {
"slug": "{검증을 요청한 값}",
"status": "valid"
}
}