Bir araç oluşturun ve yapılandırın

İş hizmeti için resmi API dokümantasyonu ile başlayın ve hesabınızın gerçekleştirmesine izin verilen bir görev. Dar, iyi tanımlanmış bir aracın test edilmesi, keyfi bir URL ve yöntemi kabul eden genel bir araçtan daha kolaydır.

Talebi tanımlayın#

Araca sabit bir ad verin ve amacını, önemli sınırlarını ve verileri değiştirip değiştirmediğini açıklayan bir açıklama verin. Belgelenen HTTP yöntemini ve uç noktasını seçin. Yer tutucuları yalnızca işlemin gerçekte izin verdiği değişken yol öğeleri için kullanın.

Kurgusal bir kayıt araması için yol, bir kayıt tanımlayıcı içerebilir. Ana bilgisayar adı ve hesap bölgesi, açık uçlu model girişi yerine yapılandırılmış bağlantının parçası olarak kalmalıdır.

Girişleri tanımlayın ve eşleyin#

Her alanı, türünü, gerekli durumu ve geçerli değerleri tanımlamak için giriş şemasını kullanın. Kurgusal bir arama için küçük bir şema:

{
  "type": "object",
  "properties": {
    "record_id": {
      "type": "string",
      "description": "The verified identifier of the record to read"
    }
  },
  "required": ["record_id"],
  "additionalProperties": false
}

Belgelenmiş yol, sorgu veya gövde alanlarına argümanları haritalayın. Eksik gerekli alanlar ve beklenmedik ekstra argümanların açıkça başarısız olup olmadığını kontrol edin. Desteklenen sunucu bağlantısında kimlik doğrulamasını tutun, bir isteminde değil, örnek şema veya sabit kodlu araç başlığında değil.

Çıkışı şekillendirin#

Yanıt haritalaması veya dönüşüm, tüm bir hizmet yanıtı yerine iş akışının ihtiyaç duyduğu alanları döndürebilir. Dönüştürülmüş çıktıyı orijinal test sonucuna karşı doğrulayın. Sonuç tamamlandı mı anlamak için gereken kayıt tanımlayıcısını, paginasyon bilgilerini veya hata ayrıntılarını kaldırmayın.

İşletim ayarlarını gözden geçirin#

Araç yapılandırması zaman aşımını, önbelleğe almayı ve yeniden deneme ayarlarını destekler. Yalnızca eski veriler kabul edilebilir olduğunda önbelleğe almayı kullanın; Önbelleğe alınmış bir okuma, bir yazmanın yeni tamamlandığının nihai kanıtı olarak uygun değildir. İmgesiz bir yazmayı yeniden denemek kopyalar oluşturabilir, bu nedenle API'nin belgelenmiş garantilerinden yeniden deneme davranışını seçin.

Gerçek yolu test edin#

Doğru girişi, geçersiz girişi, boş sonuçları, izin hatasını ve sınırlı başarılı çağrıyı kontrol edin. Test teşhisleri hassas istek bilgileri içerebilir; bunları yalnızca onaylı yönetici yoluyla inceleyin ve paylaşmadan önce düzenleyin. Görmek test Bir müşteri aracı kullanmadan önce.