# HTTP 请求与响应服务

检查请求、测试响应并调试集成。

如需生成随机字符串和标识符，请试试 [rand.hacks.run](https://rand.hacks.run/).

**Base URL**

https://200ok.hacks.run

**输出**

默认返回纯文本。使用 `?json` 获取紧凑的 JSON，或使用 `?pretty` 获取格式化的 JSON。只要参数存在，就会启用对应选项，与参数值无关。`?pretty` 的优先级高于 `?json`。

**本地运行**

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

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

默认最多允许 64 层 JSON 对象或数组嵌套。如需在本地测试更深的嵌套，请将 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/zh-CN/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[]` | 标头值。 |
