Тестирование и отладка RESTful API
Использование инструментов для тестирования API
1. Тестирование в Postman
Postman — самый популярный инструмент тестирования API, своего рода "песочница" для API.
Официальный сайт Postman:https://www.postman.com/。

Основные шаги тестирования:
- Создайте новый запрос
- Установите HTTP-метод (GET, POST и т. д.)
- Введите URL API
- Добавьте заголовки запроса и тело запроса
- Отправьте запрос и просмотрите ответ
Пример коллекции Postman:
{
"info": {
"name": "用户管理 API 测试",
"description": "测试用户相关的所有 API 端点"
},
"item": [
{
"name": "获取用户列表",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/users?page=1&limit=10",
"host": ["{{baseUrl}}"],
"path": ["api", "users"],
"query": [
{"key": "page", "value": "1"},
{"key": "limit", "value": "10"}
]
}
}
}
]
}2. Тестирование в командной строке с помощью curl
# 获取用户列表
curl -X GET "https://api.example.com/users" \
-H "Content-Type: application/json"
# 创建新用户
curl -X POST "https://api.example.com/users" \
-H "Content-Type: application/json" \
-d '{
"name": "张三",
"email": "zhangsan@example.com"
}'
# 更新用户信息
curl -X PUT "https://api.example.com/users/123" \
-H "Content-Type: application/json" \
-d '{
"name": "李四",
"email": "lisi@example.com"
}'
# 删除用户
curl -X DELETE "https://api.example.com/users/123" \
-H "Content-Type: application/json"
3. Инструменты разработчика в браузере
// 在浏览器控制台中测试
fetch('/api/users', {
method: 'GET',
headers: {
'Content-Type': 'application/json'
}
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));Отладка типичных проблем
1. Проблемы CORS при кросс-доменных запросах
Сообщение об ошибке:
Access to fetch at 'https://api.example.com/users' from origin 'http://localhost:3000' has been blocked by CORS policy
Решение:
// 服务器端需要设置 CORS 头
app.use((req, res, next) => {
res.header('Access-Control-Allow-Origin', '*');
res.header('Access-Control-Allow-Methods', 'GET,PUT,POST,DELETE');
res.header('Access-Control-Allow-Headers', 'Content-Type, Authorization');
next();
});2. Ошибки с кодами состояния
Распространённые ошибки и причины:
| Код состояния | Возможная причина | Решение |
|---|---|---|
| 400 | Ошибка формата данных запроса | Проверьте формат JSON и обязательные поля |
| 401 | Ошибка аутентификации | Проверьте, корректен ли Token |
| 404 | Ошибка пути API | Убедитесь, что URL указан правильно |
| 500 | Внутренняя ошибка сервера | Проверьте логи сервера |
3. Проблемы с форматом данных
// 错误的请求格式
{
name: "张三", // ❌ 缺少引号
'email': "test@example.com", // ❌ 单引号
age: "25" // ❌ 数字用了字符串
}
// 正确的请求格式
{
"name": "张三", // ✅ 双引号
"email": "test@example.com", // ✅ 双引号
"age": 25 // ✅ 数字类型
}Автоматизированное тестирование
Пример модульного теста
Пример
// Использовать фреймворк Jest для тестирования
describe('Тест User API', () => {
test('должен иметь возможность получить список пользователей', async () => {
const response = await fetch('/api/users');
const data = await response.json();
expect(response.status).toBe(200);
expect(data.success).toBe(true);
expect(Array.isArray(data.data)).toBe(истина);
});
test('должен иметь возможность создать нового пользователя', async () => {
const newUser = {
name: "Тестовый пользователь",
email: "test@example.com"
};
const response = await fetch('/api/users', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify(newUser)
});
const data = await response.json();
expect(response.status).toBe(201);
expect(data.success).toBe(true);
expect(data.data.name).toBe(newUser.name);
});
});
describe('Тест User API', () => {
test('должен иметь возможность получить список пользователей', async () => {
const response = await fetch('/api/users');
const data = await response.json();
expect(response.status).toBe(200);
expect(data.success).toBe(true);
expect(Array.isArray(data.data)).toBe(истина);
});
test('должен иметь возможность создать нового пользователя', async () => {
const newUser = {
name: "Тестовый пользователь",
email: "test@example.com"
};
const response = await fetch('/api/users', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify(newUser)
});
const data = await response.json();
expect(response.status).toBe(201);
expect(data.success).toBe(true);
expect(data.data.name).toBe(newUser.name);
});
});