Tests et débogage de l'API RESTful
Utilisation d'outils pour tester une API
Tests avec Postman
Postman est l'outil de test d'API le plus populaire, comme un « terrain de jeu » pour les API.
Site officiel de Postman :https://www.postman.com/。

Étapes de test de base:
- Créer une nouvelle requête
- Définir la méthode HTTP (GET, POST, etc.)
- Saisir l'URL de l'API
- Ajouter les en-têtes de requête et le corps de la requête
- Envoyer la requête et afficher la réponse
Exemple de collection 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. Test en ligne de commande 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. Outils de développement du navigateur
// 在浏览器控制台中测试
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));Débogage des problèmes courants
1. Problèmes d'origine croisée CORS
Message d'erreur :
Access to fetch at 'https://api.example.com/users' from origin 'http://localhost:3000' has been blocked by CORS policy
Solution :
// 服务器端需要设置 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. Erreurs de code d'état
Erreurs courantes et causes :
| Code d'état | Cause possible | Solution |
|---|---|---|
| 400 | Erreur de format des données de la requête | Vérifiez le format JSON et les champs obligatoires |
| 401 | Échec de l'authentification | Vérifiez si le Token est correct |
| 404 | Erreur de chemin d'API | Confirmez que l'URL est correctement orthographiée |
| 500 | Erreur interne du serveur | Vérifiez les journaux du serveur |
3. Problèmes de format de données
// 错误的请求格式
{
name: "张三", // ❌ 缺少引号
'email': "test@example.com", // ❌ 单引号
age: "25" // ❌ 数字用了字符串
}
// 正确的请求格式
{
"name": "张三", // ✅ 双引号
"email": "test@example.com", // ✅ 双引号
"age": 25 // ✅ 数字类型
}Tests automatisés
Exemple de test unitaire
Exemple
// Utilisez le framework de test Jest
describe('Test de l’API utilisateur', () => {
test('devrait pouvoir obtenir la liste des utilisateurs', 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(vrai);
});
test('devrait pouvoir créer un nouvel utilisateur', async () => {
const newUser = {
name: "Utilisateur test",
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('Test de l’API utilisateur', () => {
test('devrait pouvoir obtenir la liste des utilisateurs', 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(vrai);
});
test('devrait pouvoir créer un nouvel utilisateur', async () => {
const newUser = {
name: "Utilisateur test",
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);
});
});