Bağlayıcı Dizesi Yönergeleri

Aşağıdaki konu başlığı, Power Automate, Power Apps ve Logic Apps için bağlayıcının içindeki dize alanlarına yönelik genel yönergeleri içerir.

Bağlayıcı Bilgileri

Her bağlayıcının, bağlayıcının adı olan ve genel olarak bağlayıcıyı tanımlayan bir açıklamanın bulunduğu bir başlığı olmalıdır. Bu bilgiler, OpenAPI tanımının (apiDefinition.swagger.json dosyasında) bilgi bölümünün altında bulunan başlık ve açıklama alanlarında belirtilmelidir.

Bağlayıcı başlıkları ve açıklamaları için en azından aşağıdaki yönergelerin izlenmesi gerekir:

• Bağlayıcı başlığında en fazla 30 karakter olabilir.
• Bağlayıcı başlığı ve açıklaması API kelimesini içeremez.
• Bağlayıcı başlığı ve açıklaması, bir Power Platform ürününe veya arka uç API’sine sahip olmadığınız bir ürüne başvuramaz.

Sertifikalı bağlayıcılara uygulanan başlık ve açıklama alanı yönergelerine ilişkin daha yüksek standartlara buradan ulaşabilirsiniz. En iyi deneyimi elde etmek için bunların kullanılması gerekir.

İşlemler

OpenAPI tanımındaki her yol ve fiil bir işleme karşılık gelir. Aşağıdaki dizelerin/etiketlerin her biriyle işlemin düzgünce açıklanması son kullanıcının bunu doğru kullanmasına yardımcı olur. İşlemin dize alanlarından bazıları şunlardır:

• özet: Bu, işlemin adı olarak görünür.

  • Durum: Cümle
  • Notlar:
    • Adda eğik çizgi ('/') olmamalıdır.
    • 80 karakteri geçmemelidir.
    • Noktalama işaretleri ve boşluk da dahil olmak üzere alfasayısal olmayan karakterle bitmemesi gerekir.

• açıklama: Açıklama bilgi düğmesi seçildiğinde işlem açıklaması olarak gösterilir (aşağıdaki resimde gösterildiği gibi).

  • Durum: Cümle
  • Notlar: Metin kutusuna sığdırmak için kısa bulundurun. Tek bir sözcük olması durumunda herhangi bir dönem gerekmez.

• operationId: İşlemle ilişkilendirilmiş olan benzersiz kimliktir.

  • Servis talebi: Camel
  • Notlar: GetContacts veya CreateContact gibi, işlemin anlamını iletmesi amaçlanmıştır.

  Aşağıdaki resimde, iş akışı oluşturulurken kullanıcı arabiriminde özet (E-posta gönderin) ve açıklama (Bu işlem bir e-posta iletisi gönderir.) alanlarının nasıl görüneceği gösterilir.

  

Tetikleyiciler ve Eylemler

Bir tetikleyici, bir iş akışı veya işlem başlatır. Örneğin, "Her Pazartesi 03:00'da bir iş akışı başlat" veya "Nesne oluşturulduğunda" gibi.

Tetik Özeti ve açıklama alanları insana ve anlamsal anlamda olmalıdır. Tetikleyici özeti genellikle şu biçimdedir: "Bir __________________".

Örnek:

Tetikleyici açıklaması genellikle şu biçimdedir: "Bu işlem _______________ tetiklenir".

Örnek:

• Bu işlem yeni bir görev eklendiğinde tetiklenir.

Eylem, iş akışınız içinde tamamlanacak olan bir görevdir. Örneğin, "E-posta gönder", "Satır güncelleştir", "Bildirim gönder" gibi. Aşağıdaki eylem özeti örnekleri aşağıda verilmiştir:

Parametreler

Her işlemde (ister tetikleyici ister eylem olsun) kullanıcının giriş sağladığı parametreler bulunur. Parametre için önemli dize alanlarından bazıları:

• x-ms-summary: Bu, parametre adı olarak görünür.

  • Servis Talebi: Başlık
  • Notlar: Karakter sınırı 80'dir

• açıklama: Bu, giriş kutusunda parametre olarak görünür.

  • Durum: Cümle
  • Notlar: Metin kutusuna sığdırmak için kısa bulundurun. Tek bir sözcük olması durumunda herhangi bir dönem gerekmez.

  Aşağıdaki resimde vurgulanan parametrenin x-ms-summary alanında değer olarak "Konu" ve açıklama alanında "Postanın konusunu belirtin" değeri bulunur.

  

Yanıtla

Her işlemin, iş akışının devamında sonraki bir işlemde giriş olarak kullanılabilecek bir yanıtı vardır. Birden çok özellik için önemli dize alanlarından bazıları: Parametre için önemli dize alanlarından bazıları:

• x-ms-summary: Bu, sonuç özelliği adı olarak görünür.

  • Servis Talebi: Başlık
  • Notlar: Kısa ad kullanın.

• açıklama: Bu, sonuç özelliği için açıklama olarak görünür.

  • Durum: Cümle
  • Notlar: Kısa ve öz olması, nokta ile bitmesi gerekir.

  Aşağıda gösterilen resimde, iş akışında izleyen işlemlerden birine dinamik içerik eklemeye çalıştığınızda "bir akışı manuel tetikleme" işlemindeki sonuç şeması görünür. Burada, "Kullanıcı e-postası", "El ile bir akış tetikleme" işleminin yanıtındaki bir özelliğin x-ms-summary alanının değeridir ve onun altındaki metin de açıklama alanının değeridir.

summary/x-ms-summary ve description alanları için göz önünde bulundurulması gereken birkaç önemli not:

• Özet ve açıklama metni aynı olmamalıdır.
• Açıklama kullanıcıya çıkış biçimi veya özelliğin ilgili olduğu nesne gibi ek bilgiler sağlamak için kullanılmalıdır. Örneğin: özet : kimlik, açıklama: Kullanıcı kimliği.
• İç içe değerleri olan bir nesne söz konusu olduğunda, ana öğe adının x-ms-summary alanı alt öğe adının sonuna eklenir.

x-ms-visibility

Varlığın görünürlük önceliğini belirler. Görünürlük belirtilmediyse bunun "normal" görünürlükte olduğu varsayılır. Olası değerler şunlardır: "önemli", "gelişmiş" ve "dahili". "Dahili" olarak işaretlenen varlıklar kullanıcı arabiriminde gösterilir.

Şunlar için geçerlidir:

• İşlemler
• Parametreler
• Yanıt özellikleri

Örnek: Kullanıcı arabiriminde genellikle önce “önemli” olarak işaretlenmiş varlıklar görüntülenir, “gelişmiş” olarak işaretlenmiş öğeler iki durumlu düğmenin (vurgulanmış) altına gizlenir ve “dahili” olarak işaretlenmiş öğeler de görüntülenmez. Örneğin, aşağıdaki resimde gösterildiği gibi "önemli" olarak işaretlenen parametreler varsayılan olarak gösterilir ve "Gelişmiş seçenekleri göster" düğmesine tıkladıktan sonra "Gelişmiş" olarak işaretlenen parametreler gösterilir.