API Uç Noktalarını Karşılaştır, Kritik Değişiklikleri Belirle
API geliştiricileri ve ekipleri, iki sözleşme sürümü arasındaki kritik değişiklikleri hızlıca tespit etmek zorunda kalır. Bu iş akışı, kaldırılan uç noktaları ve yeni eklenen zorunlu alanları güvenilir şekilde belirler. İçe aktarıldıktan sonra bir webhook ile tetiklenebilir ve uyumluluğun yapılandırılmış bir değerlendirmesini sunar. Böylece zamandan tasarruf edilir, hata riski azalır ve API geliştirmede kalite güvencesi güçlenir.
Geliştiriciler, API sahipleri ve ekipler için tasarlanan API Breaking Change Checker, API sözleşmelerindeki değişikliklerin otomatik olarak uyumluluk açısından kontrol edilmesini sağlar. İş akışı üç bağlı düğümden oluşur: Bir webhook, POST yöntemiyle iki API durumunu alır (her biri method, path ve requiredFields içeren uç nokta nesneleri dizisi olarak). Bir kod düğümü, uç noktaların kaldırılıp kaldırılmadığını veya yeni zorunlu alanların eklenip eklenmediğini analiz eder. Sonuçlar, yapılandırılmış JSON formatında döndürülür; kritik değişikliklerde etkilenen uç noktalar ve alanlar açıkça belirtilir. Hatalı veya eksik girişler net bir hata mesajı ile sonuçlanır. Kurulum için harici kimlik bilgisi gerekmez; ancak üretim ortamında kullanılmadan önce n8n'de webhook kimlik doğrulaması etkinleştirilmelidir. Çalışma sırasında kullanıcı verileri n8n içinde saklanır; bu nedenle veri gizliliğine dikkat edilmelidir. İş akışı yalnızca kaldırılan uç noktalar ve yeni zorunlu alanları kontrol eder; kapsamlı şema veya tür karşılaştırmaları içermez.
Yapay Zekâ Tarafından Oluşturulan Görsel
Kurulum
1. İş akışını n8n'e içe aktarın.
2. İş akışını açın ve tüm düğümlerin doğru şekilde bağlı olduğunu kontrol edin.
3. Test dinleyicisini başlatın ve Webhook düğümünden gösterilen test URL'sini kopyalayın.
4. curl veya Postman gibi bir araçla test URL'sine POST isteği gönderin (Content-Type: application/json, aşağıdaki örneğe bakınız).
5. Sonucu kontrol edin. Başarılı testten sonra iş akışını yayınlayın/etkinleştirin ve Webhook düğümündeki üretim URL'sini kullanın.
6. Üretim öncesinde, yetkisiz erişimi önlemek için n8n'de webhook kimlik doğrulamasını yapılandırın.
Kullanım
Girdi formatı:
```json
{
"before": [
{"method": "GET", "path": "/users", "requiredFields": ["id"]},
{"method": "POST", "path": "/users", "requiredFields": ["name"]}
],
"after": [
{"method": "GET", "path": "/users", "requiredFields": ["id"]},
{"method": "POST", "path": "/users", "requiredFields": ["name", "email"]}
]
}
```
Beklenen çıktı:
```json
{
"status": "breaking_changes",
"removed": [],
"added": [],
"newRequiredFields": [
{"endpoint": "POST /users", "fields": ["email"]}
]
}
```
HTTP Durumu: 200
Hata durumu (örneğin eksik diziler):
```json
{
"before": null,
"after": []
}
```
Yanıt:
```json
{
"status": "error",
"message": "before und after müssen Arrays sein."
}
```
HTTP Durumu: 200
Notlar:
- Sadece uç nokta yolları, yöntemler ve yeni zorunlu alanlar karşılaştırılır. İsteğe bağlı alanlar veya veri türlerindeki değişiklikler algılanmaz.
- Webhook kimlik doğrulaması n8n'de ayrı olarak yapılandırılmalıdır.
- Çalıştırma sırasında kullanıcı verileri n8n içinde saklanır. Saklama ve erişim buna göre yapılandırılmalıdır.
- Karşılaştırma kuralları Kod düğümünde değiştirilebilir.
Gerekli Bağlantılar ve API'ler
API Bağlantıları
İş akışı JSON'unda kayıtlı API erişim bilgisi bulunmadı. Etkinleştirmeden önce yine de webhookları, hedef sistemleri, erişim bilgilerini ve veri korumayı kontrol edin.
Düğümler
WebhookCodeRespond to Webhook
Yalıtılmış işlev testi başarılı
İsteğe bağlı yalıtılmış işlev testi
Yalıtılmış veri akışı, harici hizmetler veya erişim bilgileri olmadan test edildi.
✓ 5 test başarıyla tamamlandıTest edilen durumları gösterTest edilen durumları gizle
✓ Eksiksiz verilerle standart durumGeçerli örnek verilerle eksiksiz standart akışı denetler.Yalıtılmış işlev testi başarılı✓ Varyasyon veya sınır durumuGeçerli bir varyasyonu veya önemli bir sınır durumunu denetler.Yalıtılmış işlev testi başarılı✓ Ek işleme kuralıBu iş akışının ek işleme kuralını denetler.Yalıtılmış işlev testi başarılı✓ Geçersiz veya eksik girdiGeçersiz veya eksik verilerin kontrollü biçimde reddedildiğini denetler.Yalıtılmış işlev testi başarılı✓ Boş girdiBoş bir isteğin kontrollü bir yanıt aldığını denetler.Yalıtılmış işlev testi başarılı
