Test Bağlantısı Uygulama

Makale
06/23/2023

Test Bağlantısı, Azure Logic Apps, Power Automate veya Power Apps ile kullanılmak üzere bağlayıcı için tanımlanabilecek basit bir giriş noktasıdır. Bağlayıcı bir işlemi test bağlantısı için kullanıma sunarak bağlantı parametrelerinin tasarım zamanı ve çalışma zamanı doğrulamasını sağlayabilir.

Ön koşullar

Temel deneyim oluşturma mantıksal uygulamalar veya akışlar ve özel bağlayıcılar.
OpenAPI Belirtimi (önceden Swagger olarak biliniyordu) hakkında temel bilgiler.
Bir GitHub hesabı.
Bu öğretici için örnek OpenAPI tanımı.

Yeni bir test bağlantısı işlemi ekleme

TestConnection için işlem eklemek çok basit bir süreçtir. Bağlantıyı test etme aracı olarak mevcut herhangi bir işlemi kullanma veya işi yalnızca bağlantı parametrelerini test etmek olan belirli bir işlem ekleme seçeneğiniz vardır. Bu bir "get" işlemi olmalıdır ve parametre olmadan veya sabit kodlanmış parametrelerle bir çağrıyı desteklemelidir.

Bu amaçla yeni işlem eklemek OpenAPI belirtiminde şuna benzer olabilir:

    "/diagnostics/testconnection": {
      "get": {
        "tags": [ "Diagnostics" ],
        "operationId": "TestMyAPIConnection",
        "consumes": [],
        "produces": [],
        "responses": {
          "200": { "description": "OK" },
          "default": { "description": "Operation Failed." }
        },
        "x-ms-visibility": "internal"
      }
    }

Önemli

Bu işlemin internal olarak işaretlendiğine dikkat edin. Bu amaçla yeni bir giriş noktası eklerseniz, görünürlüğü uygun şekilde işaretleyerek bu işlemi kullanıcıdan gizlemeniz kesinlikle önerilir.

Test bağlantısı için kullanılması amaçlanan uç noktanın, API'ye üst düzeyde bir uzantı eklenerek tanımlanması gerekir ve böylelikle:

 "x-ms-capabilities": {
    "testConnection": {
      "operationId": "TestMyAPIConnection",
      "parameters": {}
    }
  }

Bu öznitelikte belirtilen operationId öğesinin geçerli olabilmesi için bu OpenAPI belirtimi içinde bulunması gerekir.

Test bağlantısı için mevcut işlemi yeniden kullanma

Çoğunlukla fazla maliyet veya gecikme süresi getirmeden bağlantının uygulanabilir olduğunu doğrulayabilecek mevcut bir işlem tanımlamak daha basit ve daha kolay yönetilebilir bir yaklaşımdır. Bu, yeni bir işlem eklemeden yalnızca hangi işlemin kullanılacağını ve hangi parametrelerin (varsa) geçirileceğini belirterek gerçekleştirilebilir.

Aşağıdaki örnekte, GetTables adlı mevcut "get" işlemi kullanılmaktadır. Bağlantı geçerli ve parametreler doğruysa işlemin başarılı olması gerekir. Test bağlantısı işleminin mümkün olduğunca çabuk yürütüldüğünden emin olmak amacıyla yalnızca ilk satırın döndürülmesi gerektiği belirtmek için örnekte çağrıya bir parametre eklenir.

 "x-ms-capabilities": {
    "testConnection": {
      "operationId": "GetTables",
      "parameters": {
        "$top": 1
      }
    }
  }

Test bağlantısı uygulama

Test bağlantısını uygulamanız gerekiyorsa ve bu amaca uygun başka mevcut işlem yoksa, bunu çok basit bir arka uç çağrısıyla yapabilirsiniz. İşlemin hiçbir parametre alması veya hiçbir içerik döndürmesi gerekmez. URL yolu da önemli değildir ve tercihinize göre seçilebilir. Test bağlantısı çağrısının tek başarı ölçüsü, HTTP çağrısından başarılı bir yanıt (200 gibi) alınmasıdır. Test bağlantısı işleminin içinde, sözleşme bağlayıcının kimlik doğrulama bağlamını ve bağlantı parametrelerini doğrulamasını ister.

Bu, arka uçta basit bir öğe için sorgu yaparak gerçekleştirilebilir; sorguda kimlik doğrulama parametreleri ve belirtiliyor olabilecek herhangi bir veritabanı veya kapsam kullanılır. Basit bir tablonun en üst satırını sorgulamak, tek test bağlantısı yaklaşımının iyi bir örneğidir.

Geri bildirimde bulunun

Bağlayıcı platformumuzla ilgili sorunlar veya yeni özellik fikirleri hakkındaki geri bildiriminiz bizim için çok önemlidir. Geri bildirimde bulunmak için Sorun gönderme veya bağlayıcılarla ilgili yardım alma bölümüne gidip geri bildirim türünü seçin.

Share via