Pruebas y depuración de API RESTful
Probar la API con herramientas
1. Pruebas con Postman
Postman es la herramienta de prueba de API más popular, como un "campo de pruebas" para APIs.
Dirección del sitio web oficial de Postman:https://www.postman.com/。

Pasos básicos de prueba:
- Crear una nueva solicitud
- Configurar el método HTTP (GET, POST, etc.)
- Ingresar la dirección de la API
- Agregar cabeceras y cuerpo de la solicitud
- Enviar la solicitud y ver la respuesta
Ejemplo de colección de 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. Pruebas con curl en la línea de comandos
# 获取用户列表
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. Herramientas de desarrollo del navegador
// 在浏览器控制台中测试
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));Depuración de problemas comunes
1. Problema de CORS (dominio cruzado)
Mensaje de error:
Access to fetch at 'https://api.example.com/users' from origin 'http://localhost:3000' has been blocked by CORS policy
Solución:
// 服务器端需要设置 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. Errores de código de estado
Errores comunes y sus causas:
| Código de estado | Posibles causas | Solución |
|---|---|---|
| 400 | Formato incorrecto de los datos de la solicitud | Verificar el formato JSON y los campos obligatorios |
| 401 | Error de autenticación | Verificar si el Token es correcto |
| 404 | Ruta de API incorrecta | Confirmar que la URL esté bien escrita |
| 500 | Error interno del servidor | Revisar los registros del servidor |
3. Problemas de formato de datos
// 错误的请求格式
{
name: "张三", // ❌ 缺少引号
'email': "test@example.com", // ❌ 单引号
age: "25" // ❌ 数字用了字符串
}
// 正确的请求格式
{
"name": "张三", // ✅ 双引号
"email": "test@example.com", // ✅ 双引号
"age": 25 // ✅ 数字类型
}Pruebas automatizadas
Ejemplo de prueba unitaria
Ejemplo
// Usando el framework de pruebas Jest
describe('Pruebas de API de usuario', () => {
test('Debería poder obtener la lista de usuarios', 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(true);
});
test('Debería poder crear un nuevo usuario', async () => {
const newUser = {
name: "Usuario de prueba",
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('Pruebas de API de usuario', () => {
test('Debería poder obtener la lista de usuarios', 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(true);
});
test('Debería poder crear un nuevo usuario', async () => {
const newUser = {
name: "Usuario de prueba",
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);
});
});