1. 소개

유저 API 입니다.

2. 환경

서비스의 각종 환경에 대한 정보를 표시합니다.

2.1. 도메인

서비스의 도메인 호스트는 다음과 같습니다.

인프라 팀에서 설정합니다.
환경 URI

개발서버

io.github.shirohoo-dev

운영서버

io.github.shirohoo

3. 유저 API

3.1. 조회

3.1.1. 설명

유저 조회에 성공한 경우

3.1.2. 요청

요청 필드
Parameter Description

phoneNumber

휴대폰 번호
Curl 요청 코드
$ curl 'https://docs.api.com/?phoneNumber=010-1234-5678' -i -X GET
요청 예제
GET /?phoneNumber=010-1234-5678 HTTP/1.1
Host: docs.api.com

3.1.3. 응답

응답 필드
Path Type Description

name

String

이름

age

Number

나이

phoneNumber

String

휴대폰 번호

birthDay

String

생일
응답 예제
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 105

{
  "name" : "user1",
  "age" : 11,
  "phoneNumber" : "010-1234-5678",
  "birthDay" : "2000-01-01"
}

3.2. 생성

3.2.1. 설명

유저 추가에 성공한 경우

3.2.2. 요청

요청 필드
Path Type Description

name

String

이름

age

Number

나이

phoneNumber

String

휴대폰 번호

birthDay

String

생일
Curl 요청 코드
$ curl 'https://docs.api.com/' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -d '{
  "name" : "user4",
  "age" : 44,
  "phoneNumber" : "010-5678-5678",
  "birthDay" : "2000-01-01"
}'
요청 예제
POST / HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Content-Length: 105
Host: docs.api.com

{
  "name" : "user4",
  "age" : 44,
  "phoneNumber" : "010-5678-5678",
  "birthDay" : "2000-01-01"
}

3.2.3. 응답

응답 필드
Path Type Description

name

String

이름

age

Number

나이

phoneNumber

String

휴대폰 번호

birthDay

String

생일
응답 예제
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 105

{
  "name" : "user4",
  "age" : 44,
  "phoneNumber" : "010-5678-5678",
  "birthDay" : "2000-01-01"
}