# HTTP 요청 및 응답 서비스

요청을 살펴보고, 응답을 테스트하고, 연동을 디버깅하세요.

임의의 문자열과 ID가 필요하다면 다음 서비스를 사용해 보세요 [rand.hacks.run](https://rand.hacks.run/).

**Base URL**

https://200ok.hacks.run

**출력**

기본적으로 일반 텍스트를 반환합니다. 압축된 JSON은 `?json`, 서식이 적용된 JSON은 `?pretty`를 사용하세요. 매개변수는 값과 관계없이 존재하는 것만으로 활성화됩니다. `?pretty`가 `?json`보다 우선합니다.

**로컬에서 실행**

```sh
docker run --rm -p 3000:3000 ghcr.io/teplostanski/200ok:latest
```

[http://localhost:3000](http://localhost:3000/)

기본 JSON 중첩 한도는 객체 또는 배열 64단계입니다. 더 깊은 로컬 테스트에는 JSON\_MAX\_DEPTH를 1~512로 설정하세요. 본문 크기 제한 100 KiB는 그대로 적용됩니다.

```sh
docker run --rm -e JSON_MAX_DEPTH=256 -p 3000:3000 ghcr.io/teplostanski/200ok:latest
```

## Status

### `/status/{code}`

[HTTP 상태 코드 참고서](https://200ok.hacks.run/ko/status-codes)

GET, POST, PUT, PATCH, DELETE

선택한 HTTP 상태 코드와 상태 설명 문구를 반환합니다.

**중요:** `204`, `205`, `304` 응답에는 본문이 없습니다. `1xx`의 HTTP 응답 상태는 `200`입니다.

**상세 정보**

#### 요청 예제

GET

```sh
curl https://200ok.hacks.run/status/200
```

#### 응답

##### 200 OK

응답 본문에는 요청한 코드와 상태 설명 문구가 포함되며, 1xx도 동일합니다. 예: 200 OK.

예제 · text/plain

```
200 OK
```

예제 · application/json

```
{"code":200,"reason":"OK"}
```

스키마 · object

| 필드 | 유형 | 설명 |
| --- | --- | --- |
| `code`필수 | `integer` | 헤더 값입니다. |
| `reason`필수 | `string` | 헤더 값입니다. |

예제 · application/json

```
{
  "code": 200,
  "reason": "OK"
}
```

스키마 · object

| 필드 | 유형 | 설명 |
| --- | --- | --- |
| `code`필수 | `integer` | 헤더 값입니다. |
| `reason`필수 | `string` | 헤더 값입니다. |

## IP

### [`/ip`](https://200ok.hacks.run/ip)

GET

클라이언트의 IP 주소(IPv4 또는 IPv6)입니다.

**상세 정보**

#### 요청 예제

GET

```sh
curl https://200ok.hacks.run/ip
```

#### 응답

##### 200 OK

클라이언트의 IP 주소(IPv4 또는 IPv6)입니다.

예제 · text/plain

```
192.0.2.1
```

예제 · application/json

```
{"ip":"192.0.2.1"}
```

스키마 · object

| 필드 | 유형 | 설명 |
| --- | --- | --- |
| `ip`필수 | `string` | 클라이언트의 IP 주소(IPv4 또는 IPv6)입니다. |

예제 · application/json

```
{
  "ip": "192.0.2.1"
}
```

스키마 · object

| 필드 | 유형 | 설명 |
| --- | --- | --- |
| `ip`필수 | `string` | 클라이언트의 IP 주소(IPv4 또는 IPv6)입니다. |

### [`/ip/v4`](https://200ok.hacks.run/ip/v4)

GET

클라이언트의 IPv4 주소입니다.

**상세 정보**

#### 요청 예제

GET

```sh
curl https://200ok.hacks.run/ip/v4
```

#### 응답

##### 200 OK

클라이언트 연결 주소입니다. 이 예제는 문서용 IP를 사용합니다. 주소 체계가 엔드포인트와 일치하지 않으면 텍스트는 unknown, JSON은 null을 반환합니다.

예제 · text/plain

```
192.0.2.1
```

예제 · application/json

```
{"ip":"192.0.2.1"}
```

스키마 · object

| 필드 | 유형 | 설명 |
| --- | --- | --- |
| `ip`필수 | `string | null` | IP 주소입니다. 주소 체계가 일치하지 않으면 null입니다. |

예제 · application/json

```
{
  "ip": "192.0.2.1"
}
```

스키마 · object

| 필드 | 유형 | 설명 |
| --- | --- | --- |
| `ip`필수 | `string | null` | IP 주소입니다. 주소 체계가 일치하지 않으면 null입니다. |

### [`/ip/v6`](https://200ok.hacks.run/ip/v6)

GET

클라이언트의 IPv6 주소입니다.

**상세 정보**

#### 요청 예제

GET

```sh
curl https://200ok.hacks.run/ip/v6
```

#### 응답

##### 200 OK

클라이언트 연결 주소입니다. 이 예제는 문서용 IP를 사용합니다. 주소 체계가 엔드포인트와 일치하지 않으면 텍스트는 unknown, JSON은 null을 반환합니다.

예제 · text/plain

```
2001:db8::1
```

예제 · application/json

```
{"ip":"2001:db8::1"}
```

스키마 · object

| 필드 | 유형 | 설명 |
| --- | --- | --- |
| `ip`필수 | `string | null` | IP 주소입니다. 주소 체계가 일치하지 않으면 null입니다. |

예제 · application/json

```
{
  "ip": "2001:db8::1"
}
```

스키마 · object

| 필드 | 유형 | 설명 |
| --- | --- | --- |
| `ip`필수 | `string | null` | IP 주소입니다. 주소 체계가 일치하지 않으면 null입니다. |

## Echo

### [`/echo`](https://200ok.hacks.run/echo)

GET, POST, PUT, PATCH, DELETE

요청 메서드와 본문을 반환합니다. JSON, 일반 텍스트, URL 인코딩된 폼, 바이너리 데이터를 지원합니다.

**상세 정보**

#### 요청 예제

POST · JSON

```sh
curl https://200ok.hacks.run/echo \
  -H 'Content-Type: application/json' \
  --data-binary '{"name":"Bob"}'
```

POST · 일반 텍스트

```sh
curl https://200ok.hacks.run/echo \
  -H 'Content-Type: text/plain' \
  --data-binary 'Hello!'
```

POST · 폼

```sh
curl https://200ok.hacks.run/echo \
  --data-urlencode 'name=Bob' \
  --data-urlencode 'age=42'
```

POST · 바이너리 파일

```sh
curl https://200ok.hacks.run/echo \
  -H 'Content-Type: application/octet-stream' \
  --data-binary '@./file.bin'
```

#### 응답

##### 200 OK

요청 메서드와 파싱된 요청 본문입니다. 이 예제는 본문이 없는 GET 요청입니다.

예제 · text/plain

```
GET

null
```

예제 · application/json

```
{"method":"GET","body":null}
```

스키마 · object

| 필드 | 유형 | 설명 |
| --- | --- | --- |
| `method`필수 | `string` | 요청의 HTTP 메서드입니다. |
| `body`필수 | `object | array | string | number | boolean | null` | JSON 값, 문자열, 폼 필드 또는 바이너리 본문 { encoding: 'base64', sizeBytes: number, data: string }입니다. 본문이 없으면 null입니다. |

**body · 바이너리 객체**

| 필드 | 유형 | 설명 |
| --- | --- | --- |
| `encoding`필수 | `string` | 항상 `"base64"`. |
| `sizeBytes`필수 | `integer` | 원본 데이터의 바이트 수입니다. |
| `data`필수 | `string` | Base64로 인코딩된 내용입니다. |

예제 · application/json

```
{
  "method": "GET",
  "body": null
}
```

스키마 · object

| 필드 | 유형 | 설명 |
| --- | --- | --- |
| `method`필수 | `string` | 요청의 HTTP 메서드입니다. |
| `body`필수 | `object | array | string | number | boolean | null` | JSON 값, 문자열, 폼 필드 또는 바이너리 본문 { encoding: 'base64', sizeBytes: number, data: string }입니다. 본문이 없으면 null입니다. |

**body · 바이너리 객체**

| 필드 | 유형 | 설명 |
| --- | --- | --- |
| `encoding`필수 | `string` | 항상 `"base64"`. |
| `sizeBytes`필수 | `integer` | 원본 데이터의 바이트 수입니다. |
| `data`필수 | `string` | Base64로 인코딩된 내용입니다. |

##### 413 Payload Too Large

본문이 102,400바이트(100 KiB)를 초과합니다.

예제 · text/plain

```
Request body exceeds the size limit of 100 KiB
```

예제 · application/json

```
{"error":"Request body exceeds the size limit of 100 KiB","limitBytes":102400}
```

스키마 · object

| 필드 | 유형 | 설명 |
| --- | --- | --- |
| `error`필수 | `string` | 오류 설명입니다. |
| `limitBytes`필수 | `integer` | 본문의 최대 크기(바이트)입니다. 값: `102400`. |

예제 · application/json

```
{
  "error": "Request body exceeds the size limit of 100 KiB",
  "limitBytes": 102400
}
```

스키마 · object

| 필드 | 유형 | 설명 |
| --- | --- | --- |
| `error`필수 | `string` | 오류 설명입니다. |
| `limitBytes`필수 | `integer` | 본문의 최대 크기(바이트)입니다. 값: `102400`. |

##### 415 Unsupported Media Type

비어 있지 않은 본문의 Content-Type이 지원되지 않거나 누락되었습니다.

예제 · text/plain

```
Unsupported Content-Type. Supported: application/json, text/plain, application/x-www-form-urlencoded, application/octet-stream
```

예제 · application/json

```
{"error":"Unsupported Content-Type. Supported: application/json, text/plain, application/x-www-form-urlencoded, application/octet-stream"}
```

스키마 · object

| 필드 | 유형 | 설명 |
| --- | --- | --- |
| `error`필수 | `string` | 오류 설명입니다. |

예제 · application/json

```
{
  "error": "Unsupported Content-Type. Supported: application/json, text/plain, application/x-www-form-urlencoded, application/octet-stream"
}
```

스키마 · object

| 필드 | 유형 | 설명 |
| --- | --- | --- |
| `error`필수 | `string` | 오류 설명입니다. |

유효하지 않은 JSON은 400을 반환합니다. API 오류는 선택한 출력 형식인 일반 텍스트 또는 JSON으로 반환됩니다.

## Headers

### [`/headers`](https://200ok.hacks.run/headers)

GET

수신한 요청의 헤더입니다.

**상세 정보**

#### 요청 예제

사용자 지정 헤더 사용

```sh
curl https://200ok.hacks.run/headers \
  -H 'X-Test: hello'
```

#### 응답

##### 200 OK

수신한 요청의 헤더입니다. 이름과 값은 클라이언트에 따라 달라집니다.

예제 · text/plain

```
host:  localhost:3000

accept:  */*
```

예제 · application/json

```
{"host":"localhost:3000","accept":"*/*"}
```

스키마 · object

| 필드 | 유형 | 설명 |
| --- | --- | --- |
| `[헤더 이름]` | `string | string[]` | 헤더 값입니다. |

예제 · application/json

```
{
  "host": "localhost:3000",
  "accept": "*/*"
}
```

스키마 · object

| 필드 | 유형 | 설명 |
| --- | --- | --- |
| `[헤더 이름]` | `string | string[]` | 헤더 값입니다. |
