# Mock REST API 指南

创建免费的即时 REST API 端点，支持自定义响应、状态码和高级功能。无需注册。

## 快速开始

创建一个 Mock REST API 端点只需不到 30 秒。按照以下简单步骤操作：

1. 访问首页

前往 [mockapi.dog](/content/zh/index.html) 并选择 "REST API" 标签。

2. 选择 HTTP 方法

根据你的需要选择 GET、POST、PUT、PATCH 或 DELETE。

3. 编写 JSON 响应

输入你希望端点返回的 JSON 数据。编辑器实时验证 JSON。
   
   
   ```
   {
        "id": 1,
        "name": "John Doe",
        "email": "john@example.com"
   }
   ```

4. 配置延迟和错误模拟设置（可选）

如有需要，添加延迟、状态码、错误率或自定义请求头。

5. 完成验证并保存

完成 Turnstile 验证，然后点击 "保存 Mock 端点"。你的端点 URL 会自动复制！

`https://abc123.mockapi.dog/api/users`

#### 你的端点立即上线！

无需部署，无需等待。立即从你的应用、测试或 Postman、curl 等工具发起请求。

## 核心功能

### HTTP 方法

支持所有标准 HTTP 方法，匹配你的 API 设计。

- `GET`- 获取数据
- `POST`- 创建资源
- `PUT`- 完整更新
- `PATCH`- 部分更新
- `DELETE`- 删除资源

### 状态码

返回任何 HTTP 状态码以测试成功、错误和边界情况。

- 200 OK - 成功
- 201 已创建
- 400 错误请求
- 401 未授权
- 500 服务器错误

### JSON 响应

返回任何有效的 JSON 结构 —— 从简单对象到复杂的嵌套数据。

- 对象和数组
- 嵌套结构
- 对象数组
- 实时验证
- 正确的 Content-Type

## 高级功能

通过强大的功能微调你的 Mock 端点，实现真实的测试场景。

### 响应延迟

通过为响应添加延迟，模拟慢速网络或服务器处理时间。

使用场景：

- 测试 UI 中的加载状态
- 模拟慢速 3G/4G 网络
- 验证超时处理
- 检查骨架屏

示例延迟：

500ms - 快速
2000ms - 普通
5000ms - 慢速

### 错误模拟

设置一定百分比的请求返回错误。非常适合测试错误处理和重试逻辑。

使用场景：

- 测试错误边界
- 验证重试机制
- 检查错误消息
- 验证降级 UI

错误率示例：

10% 错误
50% 错误
100% 错误

### 条件错误

根据特定条件（如请求头值或请求模式）返回错误。

示例使用场景：

- 缺失请求头：如果 X-API-Key 请求头不存在，返回 401
- 特定 ID：对 userId "999" 返回 404，测试未找到的场景
- 请求方法：对不支持的 HTTP 方法返回 405

### TTL（生存时间）

为你的端点设置过期时间。指定时间后会自动删除。

可用选项：

1 小时
24 小时
7 天
30 天

非常适合临时测试或演示。无需手动清理。

## 常见任务

### 创建端点

1. 点击 "创建 REST 端点" 按钮
2. 选择 HTTP 方法
3. 输入你的 JSON 响应
4. 配置可选设置
5. 点击 "创建端点"

✓ 你的端点已上线！

### 编辑端点

1. 在 "我的端点" 列表中找到你的端点
2. 点击 "编辑" 按钮
3. 修改响应、状态或设置
4. 保存更改

✓ 更改立即生效

### 删除端点

1. 找到你想要删除的端点
2. 点击 "删除" 按钮
3. 确认删除

此操作无法撤销

### 测试端点

使用 curl：

`curl https://abc123.mockapi.dog/api/users`

使用 JavaScript：

`fetch('https://abc123.mockapi.dog/api/users')`

## 故障排除

#### 端点返回 404 未找到

**Solution:** 再次检查端点 URL。确保你使用的是创建后提供的精确 URL，包括唯一 ID。

#### 创建端点时出现无效 JSON 错误

**Solution:** 使用内置编辑器验证你的 JSON。常见问题：缺少逗号、键未加引号、尾随逗号或未转义的引号。

#### 浏览器中的 CORS 错误

**Solution:** 所有端点都自动包含 CORS 请求头。如果仍然出现错误，请检查你使用的 URL 和 HTTP 方法是否正确。

#### 端点速度太慢

**Solution:** 检查你是否在高级设置中添加了响应延迟。如果不需要，请移除或减少延迟值。

## 提示和最佳实践

#### 使用真实数据

包含与真实 API 匹配的真实字段名、数据类型和结构。这使测试更有价值。

#### 测试边界情况

为空数组、null 值和错误场景创建端点。这有助于尽早捕获 Bug。

#### 记录你的端点

保留端点及其用途的列表。与团队成员共享 URL 以协作。

#### 战略性使用延迟

添加少量延迟以测试加载状态。使用较长延迟以验证超时处理。

#### 为响应版本化

为不同的 API 版本创建多个端点。这有助于测试向后兼容性。

#### 清理未使用的端点

定期删除你不再需要的端点。使用 TTL 自动过期临时端点。

## 术语表

#### REST API

Representational State Transfer API —— 一种使用标准 HTTP 方法构建 Web 服务的架构风格。

#### HTTP 方法

标准请求方法（GET、POST、PUT、PATCH、DELETE），表示对资源的预期操作。

#### 状态码

服务器返回的三位数代码，表示请求的结果（200 OK、404 未找到、500 错误等）。

#### JSON

JavaScript Object Notation —— 一种轻量级数据格式，用于在客户端和服务器之间结构化和交换数据。

#### 端点

可访问 API 的特定 URL。每个端点执行特定功能。

#### Mock API

返回预定义响应的模拟 API，用于无需真实后端的测试和开发。

#### CORS

Cross-Origin Resource Sharing —— 一种安全功能，控制哪些域可以从浏览器访问你的 API。

#### TTL

Time To Live —— 端点在自动删除前存在的持续时间。适用于临时测试。

#### 错误率

应返回错误的请求百分比。用于测试错误处理和重试逻辑。

#### 响应延迟

在发送响应前添加的人工等待时间。模拟慢速网络或处理。

### 准备好创建你的第一个 REST API 了吗？

几秒内开始构建免费的 Mock REST API 端点。无需注册，无需信用卡。非常适合测试、原型设计和开发。