Hier is een complete workflow voor Postman om API-validaties uit te voeren met uitgebreide foutdetectie en rapportage voor jouw ShopAPI. Deze workflow omvat het gebruik van Postman test scripts, Newman voor automatisering, en integraties met e-mail en Slack. --- ### 1. **Voorbereiding:** - Installeer [Postman](https://www.postman.com/downloads/) en [Newman](https://www.npmjs.com/package/newman). - Maak een environment aan in Postman met variabelen voor e-mail en Slack webhook. **Voorbeeld environment variabelen:** - `slackWebhookUrl`: Slack webhook URL - `emailRecipient`: devteam@example.com --- ### 2. **Testscript in Postman voor validatie en foutdetectie** Voor elk endpoint, voeg de volgende testscript toe onder het tabblad **Tests**: ```javascript // Controleer op statuscode 200 pm.test("Status code is 200", function () { pm.response.to.have.status(200); }); // Controleer op Content-Type application/json pm.test("Content-Type is application/json", function () { pm.response.to.have.header("Content-Type", /application\/json/); }); // Controleer op aanwezigheid verplichte headers (bijvoorbeeld Authorization) pm.test("Verplichte headers aanwezig", function () { pm.request.headers.has('Authorization') || pm.test("Authorization header ontbreekt", () => { throw new Error("Verplichte header 'Authorization' ontbreekt"); }); }); // Detectie van afwijkingen if (pm.response.code !== 200) { sendErrorNotification(`Fout: Onverwachte statuscode ${pm.response.code} voor endpoint ${pm.request.url}`); } if (!pm.response.headers.has('Content-Type') || !pm.response.headers.get('Content-Type').includes('application/json')) { sendErrorNotification(`Fout: Verkeerde Content-Type voor endpoint ${pm.request.url}`); } // Functie om foutmeldingen te sturen naar Slack en e-mail function sendErrorNotification(message) { // Slack melding const slackPayload = { text: message + `\nEndpoint: ${pm.request.url}`, }; pm.sendRequest({ url: pm.environment.get("slackWebhookUrl"), method: 'POST', header: 'Content-Type: application/json', body: { mode: 'raw', raw: JSON.stringify(slackPayload), } }); // E-mail notificatie via externe service of API (bijvoorbeeld via Postman API of een integratie) // Hier een voorbeeld met een fictieve API voor e-mail pm.sendRequest({ url: 'https://api.your-email-service.com/send', // Vervang door echte e-mail API method: 'POST', header: 'Content-Type: application/json', body: { mode: 'raw', raw: JSON.stringify({ to: pm.environment.get("emailRecipient"), subject: 'API Foutmelding ShopAPI', body: message + `\nEndpoint: ${pm.request.url}`, }), } }); } ``` **Opmerking:** Vervang de e-mail API URL door een echte service zoals SendGrid, Mailgun, etc. --- ### 3. **Automatisering met Newman** Maak een collection in Postman met alle te testen endpoints. Exporteer deze collection en voer de tests automatisch uit met Newman. **Voorbeeld Newman command:** ```bash newman run ShopAPI_collection.json -e YourEnvironment.json --reporters cli,json,html -r json,html --reporter-html-export report.html ``` Deze command voert alle tests uit en genereert rapporten. --- ### 4. **Integratie met Slack en E-mail in automatisering** - **Slack:** Gebruik de webhook URL in je environment variabele. Zorg dat je de juiste webhook hebt ingesteld in Slack. - **E-mail:** Gebruik een API-service zoals SendGrid, Mailgun, of een andere SMTP API om automatisch e-mails te sturen bij fouten. --- ### 5. **Samenvatting van stappen** 1. **Test scripts toevoegen** in elke Postman request voor validatie en foutdetectie. 2. **Gebruik Newman** om de collectie automatisch uit te voeren. 3. **Configureer Slack webhook en e-mail API** voor automatische notificaties. 4. **Automatiseer de workflow** via CI/CD pipeline of geplande taken. --- ### 6. **Voorbeeld van volledige Postman collection** Hieronder een korte schets van een enkele request en test: ```json { "info": { "name": "ShopAPI Validatie", "_postman_id": "xxxxxx", "description": "Validatie van ShopAPI endpoints", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Get Shops", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiToken}}", "type": "text" } ], "url": { "raw": "https://api.shop.com/shops", "host": [ "api", "shop", "com" ], "path": [ "shops" ] } }, "response": [], "event": [ { "listen": "test", "script": { "exec": [ "// Test scripts zoals hierboven beschreven" ], "type": "text/javascript" } } ] } ] } ``` --- ### Conclusie Met deze opzet kun je automatische API-validaties uitvoeren, afwijkingen detecteren, en direct rapporteren via Slack en e-mail, alles geautomatiseerd met Postman en Newman. Pas de scripts en API-gegevens aan jouw specifieke situatie aan voor optimale werking.

Hier is een complete Postman workflow voor ShopAPI met automatische validaties, foutdetectie en rapportage: ## 1. Postman Collection Setup **Collection naam:** ShopAPI Automated Validation **Basis URL:** {{baseUrl}} (configureer in environment variables) ### Eindpunten toevoegen: - GET /products - GET /products/{id} - POST /orders - GET /orders/{id} ## 2. Collection Level Scripts **Pre-request Script:** ```javascript // Stel basisvariabelen in pm.collectionVariables.set("currentTimestamp", new Date().toISOString()); pm.collectionVariables.set("testRunId", Math.random().toString(36).substring(7)); ``` **Tests Script (collection level):** ```javascript // Globale validatiefuncties function validateStatusCode(expected = 200) { pm.test(`Statuscode is ${expected}`, function() { pm.response.to.have.status(expected); }); } function validateContentType() { pm.test("Content-Type is application/json", function() { pm.expect(pm.response.headers.get('Content-Type')).to.include('application/json'); }); } function validateRequiredHeaders() { const requiredHeaders = ['content-type', 'date']; requiredHeaders.forEach(header => { pm.test(`Verplichte header '${header}' aanwezig`, function() { pm.expect(pm.response.headers.has(header)).to.be.true; }); }); } // Foutdetectie functies function detectStatusCodeAnomalies() { const status = pm.response.code; if (status >= 400) { const errorData = { endpoint: pm.request.url.toString(), statusCode: status, responseBody: pm.response.text(), timestamp: new Date().toISOString() }; // Sla fout op in collection variable let errors = pm.collectionVariables.get("apiErrors") || []; errors.push(errorData); pm.collectionVariables.set("apiErrors", JSON.stringify(errors)); // Trigger Slack notificatie if (status >= 500) { sendSlackAlert(errorData); } } } // Rapportage functies function generateTestReport() { const testResults = { runId: pm.collectionVariables.get("testRunId"), timestamp: new Date().toISOString(), totalTests: pm.info.iteration, passedTests: 0, failedTests: 0, errors: JSON.parse(pm.collectionVariables.get("apiErrors") || "[]") }; pm.collectionVariables.set("testReport", JSON.stringify(testResults)); } // Maak functies globaal beschikbaar pm.collectionVariables.set("validateStatusCode", validateStatusCode.toString()); pm.collectionVariables.set("validateContentType", validateContentType.toString()); pm.collectionVariables.set("validateRequiredHeaders", validateRequiredHeaders.toString()); pm.collectionVariables.set("detectStatusCodeAnomalies", detectStatusCodeAnomalies.toString()); ``` ## 3. Request Level Tests **Voorbeeld voor GET /products:** ```javascript // Importeer globale validatiefuncties const validateStatusCode = eval(pm.collectionVariables.get("validateStatusCode")); const validateContentType = eval(pm.collectionVariables.get("validateContentType")); const validateRequiredHeaders = eval(pm.collectionVariables.get("validateRequiredHeaders")); const detectStatusCodeAnomalies = eval(pm.collectionVariables.get("detectStatusCodeAnomalies")); // Uitvoeren validaties validateStatusCode(200); validateContentType(); validateRequiredHeaders(); detectStatusCodeAnomalies(); // Specifieke response validaties pm.test("Response bevat products array", function() { const response = pm.response.json(); pm.expect(response).to.have.property('products'); pm.expect(response.products).to.be.an('array'); }); pm.test("Elk product heeft verplichte velden", function() { const response = pm.response.json(); if (response.products && response.products.length > 0) { response.products.forEach(product => { pm.expect(product).to.have.property('id'); pm.expect(product).to.have.property('name'); pm.expect(product).to.have.property('price'); }); } }); ``` ## 4. Foutdetectie en Rapportage Scripts **Slack Integration Script:** ```javascript function sendSlackAlert(errorData) { const slackWebhookUrl = pm.collectionVariables.get("SLACK_WEBHOOK_URL"); if (!slackWebhookUrl) { console.log("Slack webhook URL niet geconfigureerd"); return; } const slackMessage = { text: "🚨 ShopAPI Fout Gedetecteerd", attachments: [ { color: "danger", fields: [ { title: "Endpoint", value: errorData.endpoint, short: true }, { title: "Status Code", value: errorData.statusCode.toString(), short: true }, { title: "Tijdstip", value: errorData.timestamp, short: false } ] } ] }; pm.sendRequest({ url: slackWebhookUrl, method: 'POST', header: { 'Content-Type': 'application/json' }, body: { mode: 'raw', raw: JSON.stringify(slackMessage) } }, function (err, response) { if (err) { console.log("Slack notificatie mislukt:", err); } }); } ``` **Email Rapportage Script:** ```javascript function sendEmailReport() { const testReport = JSON.parse(pm.collectionVariables.get("testReport") || "{}"); const emailData = { to: "devteam@example.com", subject: `ShopAPI Test Rapport - ${testReport.timestamp}`, html: ` <h2>ShopAPI Test Rapport</h2> <p><strong>Run ID:</strong> ${testReport.runId}</p> <p><strong>Datum:</strong> ${testReport.timestamp}</p> <p><strong>Totaal tests:</strong> ${testReport.totalTests}</p> <p><strong>Fouten gedetecteerd:</strong> ${testReport.errors.length}</p> ${testReport.errors.length > 0 ? ` <h3>Fouten:</h3> <ul> ${testReport.errors.map(error => ` <li> <strong>Endpoint:</strong> ${error.endpoint}<br> <strong>Status:</strong> ${error.statusCode}<br> <strong>Tijd:</strong> ${error.timestamp} </li> `).join('')} </ul> ` : '<p>Geen fouten gedetecteerd ✅</p>'} ` }; // Gebruik Postman's built-in email functionaliteit of externe service pm.sendRequest({ url: 'https://api.emailservice.com/send', method: 'POST', header: { 'Content-Type': 'application/json', 'Authorization': 'Bearer ' + pm.collectionVariables.get("EMAIL_API_KEY") }, body: { mode: 'raw', raw: JSON.stringify(emailData) } }); } ``` ## 5. Environment Variables Configureer deze variabelen in je Postman environment: ```json { "baseUrl": "https://api.jouwshop.com", "SLACK_WEBHOOK_URL": "https://hooks.slack.com/services/...", "EMAIL_API_KEY": "jouw_email_api_key", "devteam_email": "devteam@example.com" } ``` ## 6. Collection Runner Setup **Test Data (indien nodig):** ```json [ { "productId": 1, "orderId": 1001 }, { "productId": 2, "orderId": 1002 } ] ``` **Run Configuration:** - Iterations: 1 - Delay: 1000ms - Data File: Optional CSV/JSON - Environment: Jouw ShopAPI environment ## 7. Monitor en Scheduler **Postman Monitor instellen:** 1. Ga naar de Collection 2. Klik op "Monitors" 3. Configureer: - Frequentie: Elke 30 minuten - Environment: ShopAPI Production - Notifications: Email bij failures **Voorbeeld Newman Command (CI/CD):** ```bash newman run ShopAPI_Collection.json \ -e Production_Environment.json \ --reporters cli,json,html \ --reporter-json-export report.json \ --reporter-html-export report.html ``` Deze workflow biedt complete automatisering van API validaties, real-time foutdetectie, en geïntegreerde rapportage via zowel email als Slack. Alle scripts zijn direct klaar voor gebruik in Postman.