Aracılığıyla paylaş

Fabric REST API dokümantasyonu yapısı

Microsoft Fabric REST API'leri, geliştiricilerin Fabric'i otomatikleştirmesine yardımcı olmak için tasarlanmıştır. Doku REST API başvuru sayfaları (belgeler), geliştiricilerin ihtiyaç duydukları bilgileri bulmasına yardımcı olmak için yapılandırılmıştır.

Başvuru sayfaları iki ana bölüme ayrılır:

  • Temel API'ler - Temel API'ler, Microsoft Fabric içindeki tüm öğeler için bilgi ve işlevsellik sağlar. Çekirdek API'ler tek bir iş yüküne özgü değildir ve tüm iş yüklerinde kullanılabilir. Temel API'ler Oluşturma, Okuma, Güncelleştirme ve Silme (CRUD) API'leridir. Doku öğelerini ortak özellikleriyle birlikte oluşturmak veya güncelleştirmek için bunları kullanabilirsiniz. Çekirdek API'ler, belirli bir öğe türüne özgü herhangi bir özelliğin değiştirilmesini zorlamayan toplu işlemler yürütülürken kullanılabilir.

  • İş yükü API'leri - İş yükü API'leri Doku'da belirli bir öğe türünü hedefler.

Çekirdek ve iş yükü başvuru sayfası bölümleri tüm API'leri alfabetik olarak listeler. Her bölüm, bölümdeki tüm API'lerin listesini ve bölümdeki API'lerin alfabetik listesini içeren bir genel bakış içerir.

Öğeye Özgü Giriş

Öğeye özgü bölüm, Fabric'deki her öğe türünün ayrıntılarını içerir. Her öğe türü girdisi şunu içerir:

  • Genel bakış: Öğe türünün kısa bir açıklaması.

  • Uç noktalar: Öğe türü için kullanılabilir uç noktaları, parametreler, istek ve yanıt biçimleri ve örneklerle birlikte listeler.

  • Modeller: Özellik ve türleri belirterek öğe türü için veri modelini tanımlar.

  • Eylemler: Parametreler, istek ve yanıt biçimleri ve örnekler de dahil olmak üzere öğe türü için kullanılabilir eylemleri listeler.

API'nin belirli bir öğe türüyle ilgili benzersiz yönlerini anlamak ve bu öğe türüyle ilgili işlemleri gerçekleştirme yönergeleri için öğeye özgü girişi kullanın.

Başvuru sayfası yapısı

Her başvuru sayfasında aşağıdaki bölümler vardır:

  • Genel Bakış - Makalenin üst kısmında API'yi açıklayan kısa bir paragraf.

  • İzinler - API'yi çağırmak için gereken kullanıcı izinlerinin listesi.

  • Gerekli kapsam - API'nin gerektirdiği izinlerin listesi (kapsamlar olarak da bilinir).

  • Sınırlamalar - (İsteğe bağlı) API'ye yönelik sınırlamaların listesi.

  • Arabirim - API'nin HTTP biçimini görüntüler.

  • URI Parametreleri - Belirli bir kaynağı veya kaynakları tanımlamak için kullanılan parametrelerin listesi.

  • İstek Gövdesi - API'ye geçirilebilen özelliklerin listesi.

  • Yanıtlar - API'den gelen olası yanıtların listesi.

  • Örnekler - API'nin nasıl kullanılacağını gösteren örneklerin listesi.

  • Tanımlar - API'ye geçirilebilen bir nesnenin yapısını ve özelliklerini tanımlayan parametreler.

Yeni API belgeleri başvuru yapısı, API bilgilerine erişmek ve bunları kullanmak için net ve tutarlı bir yol sağlamaya yöneliktir. CORE bölümünü ve öğeye özgü girişi ayırarak, geliştiricilerin Microsoft Fabric hizmetiyle tümleştirmek için ihtiyaç duydukları bilgileri bulmasını ve kullanmasını kolaylaştırmalarını umuyoruz.

Belgeleri ve API'yi geliştirme hakkındaki geri bildirimlerinizi ve önerilerinizi memnuniyetle karşılıyoruz.

İlgili içerik

  • Last updated on