Natuurlijk! Hier is een stapsgewijze aanpak om een Postman-workflow te ontwikkelen voor het beheren van meerdere API-versies en het automatisch uitvoeren van compatibiliteitstesten: 1. Organiseer je API-versies in een Postman Collection: - Maak voor elke API-versie (v1, v2, v3) een aparte folder binnen één collectie. - Voeg binnen elke folder de relevante endpoints (/users, /orders) toe. 2. Parametriseer de basis-URL: - Gebruik een collectie- of environment-variabele (bijvoorbeeld `api_version`) voor de API-versie. - Stel de URL in als `https://api.jouwdomein.com/{{api_version}}/users` (bijvoorbeeld). 3. Automatische versie-selectie: - Creëer een environment-variable `api_version`. - Schrijf een pre-request script of gebruik een setup-script dat de juiste versie kiest op basis van criteria (bv. hoogste versie, beschikbaarheid, of een andere logica). - Voor automatische selectie kun je bijvoorbeeld een API-endpoint gebruiken dat de ondersteunde versies retourneert, en op basis daarvan de variabele instellen. 4. Test-requests maken: - Voeg tests toe die controleren of de responses correct zijn en of endpoints niet deprecated zijn. 5. Compatibiliteitstesten automatiseren: - Voor backward compatibility: vergelijk responses tussen oude en nieuwe versies. - Voor deprecated endpoints: maak een lijst van endpoints die deprecated zijn en test ze op response status en gedrag. 6. Automatisering met Newman: - Exporteer je collectie. - Maak een script of CI/CD-pipeline die Newman gebruikt om de collectie uit te voeren. - Automatisch de `api_version` variabele instellen vóór de tests (bijvoorbeeld door een script dat de juiste versie bepaalt). 7. Voorbeeld van een script voor automatische versie-selectie: ```javascript // Voorbeeld: stel de versie in op basis van beschikbaarheid pm.sendRequest("https://api.jouwdomein.com/versions", function (err, res) { if (err) { pm.environment.set("api_version", "v1"); // fallback } else { let versions = res.json().versions; // verwacht een array ['v1', 'v2', 'v3'] // Logica om de hoogste ondersteunde versie te kiezen let selectedVersion = versions.sort().slice(-1)[0]; pm.environment.set("api_version", selectedVersion); } }); ``` 8. Testresultaten analyseren: - Voeg tests toe die aangeven of endpoints backward compatible zijn. - Gebruik test-asserties om de compatibiliteit te valideren. 9. Integratie in CI/CD: - Automatiseer het hele proces door Newman in je pipeline te gebruiken. - Voer de collectie uit, verzamel resultaten en stuur rapportages. Door deze workflow te implementeren, beheer je effectief meerdere API-versies en voer je geautomatiseerde compatibiliteitstesten uit, inclusief automatische versie-selectie.

Hier is een uitgebreide Postman workflow voor het beheren van API-versies en compatibiliteitstesten: ## 1. Postman Environment Setup Maak eerst environments aan voor elke versie: ```json { "v1": { "base_url": "https://api.jouwdomein.com/v1", "version": "v1" }, "v2": { "base_url": "https://api.jouwdomein.com/v2", "version": "v2" }, "v3": { "base_url": "https://api.jouwdomein.com/v3", "version": "v3" } } ``` ## 2. Collection Structuur ``` API Versie Management/ ├── Pre-request Scripts ├── Tests ├── v1/ │ ├── Users │ └── Orders ├── v2/ │ ├── Users │ └── Orders ├── v3/ │ ├── Users │ └── Orders └── Compatibiliteitstesten/ ├── Backward Compatibility └── Deprecated Endpoints ``` ## 3. Automatische Versie-Selectie **Pre-request Script (Collection Level):** ```javascript // Automatische versie detectie const currentEnv = pm.environment.name; const baseUrls = { 'v1': 'https://api.jouwdomein.com/v1', 'v2': 'https://api.jouwdomein.com/v2', 'v3': 'https://api.jouwdomein.com/v3' }; // Stel base URL in op basis van environment pm.environment.set("base_url", baseUrls[currentEnv]); pm.environment.set("current_version", currentEnv); ``` ## 4. Compatibiliteitstesten Collection ### Backward Compatibility Tests ```javascript // Test: Backward compatibility voor /users endpoint pm.test("Backward compatibility - Users endpoint", function() { const response = pm.response.json(); // Verplichte velden die in alle versies moeten bestaan pm.expect(response).to.have.property('users'); pm.expect(response.users).to.be.an('array'); // Optioneel: specifieke veld validatie per versie if (pm.environment.get('current_version') === 'v1') { pm.expect(response.users[0]).to.have.property('id'); pm.expect(response.users[0]).to.have.property('name'); } }); // Test: Backward compatibility voor /orders endpoint pm.test("Backward compatibility - Orders endpoint", function() { const response = pm.response.json(); pm.expect(response).to.have.property('orders'); pm.expect(response.orders).to.be.an('array'); }); ``` ### Deprecated Endpoints Monitoring ```javascript // Test: Controleer deprecated endpoints pm.test("Deprecated endpoint check", function() { const currentVersion = pm.environment.get('current_version'); const deprecatedEndpoints = { 'v2': ['/users/old-endpoint'], 'v3': ['/orders/legacy', '/users/deprecated-method'] }; const url = pm.request.url.toString(); // Waarschuw voor deprecated endpoints deprecatedEndpoints[currentVersion]?.forEach(endpoint => { if (url.includes(endpoint)) { pm.expect(pm.response.code).to.be.oneOf([200, 410]); console.warn(`DEPRECATED: ${endpoint} in gebruik in ${currentVersion}`); } }); }); ``` ## 5. Workflow Automation ### Collection Runner Configuratie ```json { "environment": "v1", "iterations": 1, "delay": 1000 } ``` ### Newman Script voor CI/CD ```bash # Test alle versies sequentieel newman run "API Versie Management.postman_collection.json" -e v1.env.json newman run "API Versie Management.postman_collection.json" -e v2.env.json newman run "API Versie Management.postman_collection.json" -e v3.env.json # Parallel uitvoeren (Linux/Mac) newman run collection.json -e v1.env.json & newman run collection.json -e v2.env.json & newman run collection.json - e v3.env.json & ``` ## 6. Geavanceerde Automatisering ### Dynamic Version Selection Script ```javascript // Voor automatische test cycles tussen versies const versions = ['v1', 'v2', 'v3']; let currentVersionIndex = 0; function rotateVersion() { currentVersionIndex = (currentVersionIndex + 1) % versions.length; return versions[currentVersionIndex]; } // Gebruik in Pre-request Script const nextVersion = rotateVersion(); pm.environment.set("next_test_version", nextVersion); ``` ### Monitor Script voor Breaking Changes ```javascript // Monitor voor breaking changes tussen versies pm.test("No breaking changes in response structure", function() { const response = pm.response.json(); const requiredFields = ['data', 'status', 'timestamp']; requiredFields.forEach(field => { pm.expect(response).to.have.property(field); }); // Response time monitoring pm.expect(pm.response.responseTime).to.be.below(1000); }); ``` ## 7. Implementatie Stappen 1. **Maak environments aan** voor v1, v2, v3 2. **Importeer de collection structure** zoals hierboven beschreven 3. **Configureer endpoints** voor elke versie 4. **Voeg compatibiliteitstesten toe** aan de test scripts 5. **Stel Collection Runner in** voor automatische uitvoering 6. **Integreer met CI/CD** via Newman Deze workflow zorgt voor: - ✅ Automatische versie-selectie - ✅ Backward compatibility validatie - ✅ Deprecated endpoint monitoring - ✅ Cross-version compatibiliteitstesten - ✅ CI/CD integratie mogelijkheden Wil je dat ik specifieke onderdelen verder uitwerk?