Bir demo ekranı veri akışını tek başına doğrulamaz. Kabul sözleşmesi ham olay, kimlik, zaman, alan ve hata yanıtlarını belirtmelidir.
Nesne ve olay kimliğini tanımlayın
Her endpoint için nesne, olay, yöntem, şema sürümü, zorunlu alan, birim ve yetki rolünü yazın. GS1 tanımlayıcısı seçiliyorsa hangi alanın kimlik taşıdığını ayrıca belirleyin; Digital Link tek başına API şemasını tanımlamaz.
| API öğesi | Sözleşmede yazılacak | Sınama | Kayıt |
|---|---|---|---|
| Kimlik | Kap, olay ve tekillik anahtarı | Bilinmeyen/tekrar kimlik | İstek ve yanıt |
| Zaman | Olay zamanı ve alım zamanı | Saat farkı ve sıra | Kaynak ve saat dilimi |
| Veri alanı | Şema sürümü, tür ve birim | Eksik/geçersiz alan | Hata gövdesi |
| Durum | Başarı, bekleme, hata | Yeniden deneme davranışı | Sunucu olayı |
Olay saatini yanıt saatinden ayırın. Cihazdaki oluşum zamanı, sunucunun kabul zamanı ve yanıtın tamamlanma zamanını ayrı alanlarda tutun. Saat kaynağı ve zaman dilimi bilinsin; tekilleştirme sırası olay kimliğine ve sürüm kuralına bağlansın.
Tekrar ve sırasız geliş kuralını yazın. Durum değiştiren istek için aynı idempotency anahtarının tekrarında beklenen davranışı belirleyin. Sıra dışı, geç, eksik veya yinelenen olayın kabul, reddetme ya da inceleme yolunu önceden tarif edin.
Hata ve yetki testlerini dondurun
Yetkisiz istek, zaman aşımı, ağ kesintisi, şema uyumsuzluğu ve eksik sayfa için beklenen yanıtı ve takip sahibini tanımlayın. Demo sonucu ham istek-yanıt arşivinin yerini tutmaz.
Kaynak ve hedef kayıtları uzlaştırın
Pilot sırasında kaynak olay defterini, istek kimliğini ve sunucu yanıtını birlikte saklayın. Eksik veya çift olay, sıra uyuşmazlığı ya da sürüm farkı çözülmeden kapsam ve API kararı yayımlanmaz. Düzeltme yeni şema/test sürümü açar; eski yanıt dosyası silinmez.
