Testen und Debuggen der RESTful API
Verwendung von Tools zum Testen von APIs
1. Testen mit Postman
Postman ist das beliebteste API-Testwerkzeug, wie ein "Spielplatz" für APIs.
Offizielle Postman-Website:https://www.postman.com/。

Grundlegende Testschritte:
- Eine neue Anfrage erstellen
- HTTP-Methode festlegen (GET, POST usw.)
- API-URL eingeben
- Anfrage-Header und Anfrage-Body hinzufügen
- Anfrage senden und Antwort anzeigen
Beispiel für eine Postman-Sammlung:
{
"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-Befehlszeilentest
# 获取用户列表
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. Browser-Entwicklertools
// 在浏览器控制台中测试
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));Häufige Probleme debuggen
1. CORS-Cross-Origin-Probleme
Fehlermeldung:
Access to fetch at 'https://api.example.com/users' from origin 'http://localhost:3000' has been blocked by CORS policy
Lösung:
// 服务器端需要设置 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. Statuscode-Fehler
Häufige Fehler und Ursachen:
| Statuscode | Mögliche Ursache | Lösung |
|---|---|---|
| 400 | Fehler im Anfragedatenformat | JSON-Format und Pflichtfelder prüfen |
| 401 | Authentifizierung fehlgeschlagen | Prüfen, ob das Token korrekt ist |
| 404 | API-Pfadfehler | Bestätigen Sie, dass die URL korrekt geschrieben ist |
| 500 | Interner Serverfehler | Server-Logs überprüfen |
3. Probleme mit dem Datenformat
// 错误的请求格式
{
name: "张三", // ❌ 缺少引号
'email': "test@example.com", // ❌ 单引号
age: "25" // ❌ 数字用了字符串
}
// 正确的请求格式
{
"name": "张三", // ✅ 双引号
"email": "test@example.com", // ✅ 双引号
"age": 25 // ✅ 数字类型
}Automatisiertes Testen
Beispiel für einen Unit-Test
Beispiel
// Verwende das Jest-Testframework
describe('Benutzer-API-Test', () => {
test('sollte die Benutzerliste abrufen können', 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(wahr);
});
test('sollte einen neuen Benutzer erstellen können', async () => {
const newUser = {
name: "Test User",
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('Benutzer-API-Test', () => {
test('sollte die Benutzerliste abrufen können', 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(wahr);
});
test('sollte einen neuen Benutzer erstellen können', async () => {
const newUser = {
name: "Test User",
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);
});
});