사용자 정보 API

# 사용자 목록 조회

기본 사용자 목록만 반환하며, 생성, 수정, 삭제한 사용자가 포함되지는 않습니다.

cURL

content_copy

L

1
2
curl https://api.heropy.dev/v0/users
  \ -X 'GET'

JS

content_copy

L
L
L
L
L
L
L

1
2
3
4
5
6
7
;(async () => {
  const res = await fetch('https://api.heropy.dev/v0/users', {
    method: 'GET'
  })
  const data = await res.json()
  console.log(data)
})()

요청 코드 예시

요청 데이터 타입 및 예시:

없음

응답 데이터 타입 및 예시:

TS

content_copy

L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
interface ResponseValue {
  total: number
  users: {
    id: string
    name: string
    age: number
    isValid: boolean
    emails: string[]
    photo?: {
      name: string
      size: number
      mimeType: string
      url: string
    }
  }[]
}

응답 데이터 타입

JSON

content_copy

L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
{
  "total": 7,
  "users": [
    {
      "id": "ywTTX",
      "name": "Neo",
      "age": 85,
      "isValid": true,
      "emails": [
        "neo1@heropy.dev",
        "neo2@heropy.dev"
      ],
      "photo": {
        "name": "neo.jpg",
        "size": 517122,
        "mimeType": "image/jpeg",
        "url": "https://picsum.photos/id/406/400"
      }
    },
    {
      "id": "bhxd4",
      "name": "Trinity",
      "age": 22,
      "isValid": false,
      "emails": [
        "trinity1@heropy.dev"
      ],
      "photo": {
        "name": "trinity.jpg",
        "size": 102392,
        "mimeType": "image/jpeg",
        "url": "https://picsum.photos/id/201/400"
      }
    },
    {
      "id": "MO3Tq",
      "name": "Emily",
      "age": 45,
      "isValid": false,
      "emails": [
        "emily1@heropy.dev"
      ]
    },
    // ...
  ]
}

응답 데이터 예시

# 사용자 생성

새로운 사용자를 생성합니다.
생성한 사용자가 목록을 조회할 때 포함되지는 않습니다.
응답으로 반환한 데이터는 생성한 사용자의 정보입니다.
photo 속성은 업로드한 이미지의 정보를 반환하지만, 접근 가능한 주소(url)는 샘플 주소입니다.

cURL

content_copy

L

1
2
curl https://api.heropy.dev/v0/users
  \ -X 'POST'

JS

content_copy

L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
;(async () => {
  const res = await fetch('https://api.heropy.dev/v0/users', {
    method: 'POST',
    body: JSON.stringify({
      name: 'HEROPY',
      age: 85,
      isValid: true,
      emails: ['thesecon@gmail.com'],
      photo: {
        name: 'heropy.png',
        data: 'data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDABQODxIPDRQSEBIXFRQYHjIhHhwcHj0sLiQySUBMS0dARkVQWnNiUFVtVkVGZIhlbXd7gYKBTmCNl4x9lnN+gXz/2wBDARUXFx4aHjshITt8U0ZTfHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHz/wAARCAAkACQDASIAAhEBAxEB/8QAGQAAAgMBAAAAAAAAAAAAAAAAAAUDBAYB/8QAKRAAAgICAAUDAwUAAAAAAAAAAQIAAwQRBRITITFBUXEVgaEiJEJSYf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/8QAHBEAAwEBAAMBAAAAAAAAAAAAAAECERIDITFB/9oADAMBAAIRAxEAPwBCBs6kngak60BcDqEfqZtj4jrF4Tj0Gprh1WcbVWbWzrfYev3iKlW4V55+i7D4PkZmO1yEL/UH+UX3VtWxVxysp0RN1bYuPWNBVXxsnQERcapH1Kiwpy867cfHbv8AiDeLQ514Z2ElyqujkOnoD2+IRk01qJtOXjGeKVOHW3LzKFZWA8jtNPUf2tbBeYhAQPtMXg5fQJRhtG/Bmg4Znpagxb1Ycg2jbPcfb2kvHNS2s9HRVTST32Nls6jcvTbXklhqK+LneQEA2zV637Dm8/iXLbsWpDabC4Qb0HLRBl8TL2Pc9ZVmGlXfgCbfXL5RkOel0xfxFg2W2vQAQlZmLMWPck7MI8TzKRG66p0ck1OTdQ6vU5VlOwfaEI6FLWVxjLy6xXYyhfJCrrfzKDMWO2JJ/wBhCZ+A/pyEIQA//9k='
      }
    })
  })
  const data = await res.json()
  console.log(data)
})()

요청 코드 예시

요청 데이터 타입 및 예시:

TS

content_copy

L
L
L
L
L
L
L
L
L
L

1
2
3
4
5
6
7
8
9
10
interface RequestBody {
  name: string
  age: number
  isValid?: boolean
  emails?: string[]
  photo?: {
    name: string
    data: string // Base64
  }
}

요청 데이터 타입

JSON

content_copy

L
L
L
L
L
L
L
L
L
L
L
L

1
2
3
4
5
6
7
8
9
10
11
12
{
  "name": "ParkYoungWoong",
  "age": 25,
  "isValid": true,
  "emails": [
    "thesecon@gmail.com"
  ],
  "photo": {
    "name": "profile.jpg",
    "data": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBD..."
  }
}

요청 데이터 예시

응답 데이터 타입 및 예시:

TS

content_copy

L
L
L
L
L
L
L
L
L
L
L
L
L

1
2
3
4
5
6
7
8
9
10
11
12
13
interface RequestBody {
  id: string
  name: string
  age: number
  isValid: boolean
  emails: string[]
  photo?: {
    name: string
    size: number
    mimeType: string
    url: string // 샘플 이미지 주소
  }
}

응답 데이터 타입

JSON

content_copy

L
L
L
L
L
L
L
L
L
L
L
L
L
L
L

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "id": "ywTTX",
  "name": "ParkYoungWoong",
  "age": 25,
  "isValid": true,
  "emails": [
    "thesecon@gmail.com"
  ],
  "photo": {
    "name": "profile.jpg",
    "size": 236172,
    "mimeType": "image/jpeg",
    "url": "https://picsum.photos/id/21/400"
  }
}

응답 데이터 예시

# 사용자 확인

기본 사용자 목록에 포함된 사용자 ID를 통해 해당 사용자 정보를 조회합니다.

cURL

content_copy

L

1
2
curl https://api.heropy.dev/v0/users/:userId
  \ -X 'GET'

JS

content_copy

L
L
L
L
L
L
L

1
2
3
4
5
6
7
;(async () => {
  const res = await fetch('https://api.heropy.dev/v0/users/ywTTX', {
    method: 'GET'
  })
  const data = await res.json()
  console.log(data)
})()

요청 코드 예시

요청 데이터 타입 및 예시:

없음

응답 데이터 타입 및 예시:

TS

content_copy

L
L
L
L
L
L
L
L
L
L
L
L
L

1
2
3
4
5
6
7
8
9
10
11
12
13
interface ResponseValue {
  id: string
  name: string
  age: number
  isValid: boolean
  emails: string[]
  photo?: {
    name: string
    size: number
    mimeType: string
    url: string // 샘플 이미지 주소
  }
}

응답 데이터 타입

JSON

content_copy

L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  "id": "ywTTX",
  "name": "Neo",
  "age": 85,
  "isValid": true,
  "emails": [
    "neo1@heropy.dev",
    "neo2@heropy.dev"
  ],
  "photo": {
    "name": "neo.jpg",
    "size": 517122,
    "mimeType": "image/jpeg",
    "url": "https://picsum.photos/id/406/400"
  }
}

응답 데이터 예시

# 사용자 수정

기본 사용자 목록에 포함된 사용자 ID를 통해 해당 사용자 정보를 수정합니다.
사용자 정보를 수정해도 조회한 기본 사용자 목록에는 반영되지는 않습니다.
사용자 프로필 사진(photo)에서 null 값을 전송하면, 프로필 사진을 삭제합니다.

cURL

content_copy

L

1
2
curl https://api.heropy.dev/v0/users/:userId
  \ -X 'PUT'

JS

content_copy

L
L
L
L
L
L
L
L
L
L
L

1
2
3
4
5
6
7
8
9
10
11
;(async () => {
  const res = await fetch('https://api.heropy.dev/v0/users/ywTTX', {
    method: 'PUT',
    body: JSON.stringify({
      name: "HEROPY",
      emails: ['thesecon@gmail.com']
    })
  })
  const data = await res.json()
  console.log(data)
})()

요청 코드 예시

요청 데이터 타입 및 예시:

TS

content_copy

L
L
L
L
L
L
L
L
L
L

1
2
3
4
5
6
7
8
9
10
interface RequestBody {
  name?: string
  age?: number
  isValid?: boolean
  emails?: string[]
  photo?: {
    name: string
    data: string // Base64
  } | null // 삭제할 경우!
}

요청 데이터 타입

JSON

content_copy

L
L
L
L
L
L
L
L
L
L
L
L

1
2
3
4
5
6
7
8
9
10
11
12
{
  "name": "ParkYoungWoong",
  "age": 25,
  "isValid": true,
  "emails": [
    "thesecon@gmail.com"
  ],
  "photo": {
    "name": "profile.jpg",
    "data": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBD..."
  }
}

요청 데이터 예시

응답 데이터 타입 및 예시:

TS

content_copy

L
L
L
L
L
L
L
L
L
L
L
L
L

1
2
3
4
5
6
7
8
9
10
11
12
13
interface ResponseValue {
  id: string
  name: string
  age: number
  isValid: boolean
  emails: string[]
  photo?: {
    name: string
    size: number
    mimeType: string
    url: string // 샘플 이미지 주소
  }
}

응답 데이터 타입

JSON

content_copy

L
L
L
L
L
L
L
L
L
L
L
L
L
L
L

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "id": "ywTTX",
  "name": "ParkYoungWoong",
  "age": 25,
  "isValid": true,
  "emails": [
    "thesecon@gmail.com"
  ],
  "photo": {
    "name": "neo.jpg",
    "size": 517122,
    "mimeType": "image/jpeg",
    "url": "https://picsum.photos/id/406/400" // 샘플 이미지
  }
}

응답 데이터 예시

# 사용자 삭제

기본 사용자 목록에 포함된 사용자 ID를 통해 해당 사용자 정보를 삭제합니다.
사용자 정보를 삭제해도 조회한 기본 사용자 목록에는 반영되지는 않습니다.

cURL

content_copy

L

1
2
curl https://api.heropy.dev/v0/users/:userId
  \ -X 'DELETE'

JS

content_copy

L
L
L
L
L
L
L

1
2
3
4
5
6
7
;(async () => {
  const res = await fetch('https://api.heropy.dev/v0/users/ywTTX', {
    method: 'DELETE'
  })
  const data = await res.json()
  console.log(data)
})()

요청 코드 예시

요청 데이터 타입 및 예시:

없음

응답 데이터 타입 및 예시:

TS

content_copy

L
L
L
L
L
L
L
L
L
L
L
L
L

1
2
3
4
5
6
7
8
9
10
11
12
13
interface ResponseValue {
  id: string
  name: string
  age: number
  isValid: boolean
  emails: string[]
  photo?: {
    name: string
    size: number
    mimeType: string
    url: string // 샘플 이미지 주소
  }
}

응답 데이터 타입

JSON

content_copy

L
L
L
L
L
L
L
L
L
L
L
L
L
L
L
L

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  "id": "ywTTX",
  "name": "Neo",
  "age": 85,
  "isValid": true,
  "emails": [
    "neo1@heropy.dev",
    "neo2@heropy.dev"
  ],
  "photo": {
    "name": "neo.jpg",
    "size": 517122,
    "mimeType": "image/jpeg",
    "url": "https://picsum.photos/id/406/400" // 샘플 이미지
  }
}

응답 데이터 예시

# 사용자 정의 HTTP 상태 코드

모든 요청은 200부터 599 사이의 HTTP 상태 코드를 임의로 지정할 수 있으며, 그에 맞는 응답(Response)을 받을 수 있습니다.
Request-Status 요청 헤더에 원하는 상태 코드를 지정합니다.

JS

content_copy

L
L
L
L
L
L
L
L
L
L
L
L
L

1
2
3
4
5
6
7
8
9
10
11
12
13
;(async () => {
  try {
    await fetch('https://api.heropy.dev/v0/users', {
      method: 'GET',
      headers: {
        'Request-Status': 444
      }
    })
  } catch (err) {
    console.error(err.response.status) // 444
    console.error(err.response.data.message) // '444: 잘못된 요청입니다.'
  }
})()