Aracılığıyla paylaş


Öğretici: Özel meta verileri tanımlama

Bu öğreticide API'lerinizi ve API merkezinizdeki diğer bilgileri düzenlemenize yardımcı olacak özel meta veriler tanımlayın. Arama ve filtreleme için özel ve yerleşik meta veriler kullanın ve kuruluşunuzda idare standartlarını zorunlu kılın.

Azure API Center'daki meta veriler hakkında arka plan bilgileri için bkz:

Bu öğreticide portalı kullanarak şunları yapmayı öğreneceksiniz:

  • API merkezinizde özel meta veriler tanımlama
  • Meta veri şemasını görüntüleme

Önkoşullar

Meta verileri tanımlama

Burada iki özel meta veri örneği tanımlarsınız: İş kolu ve Genel kullanıma yönelik; tercih ederseniz kendi meta verilerinizi tanımlayın. Envanterinize API'leri ve diğer bilgileri eklediğinizde veya güncelleştirdiğinizde, özel ve tüm yaygın yerleşik meta veriler için değerler ayarlarsınız.

Önemli

Tanımladığınız meta verilerin başlıklarına (adlar) hassas, gizli veya kişisel bilgiler eklemeyin. Bu başlıklar, Hizmetin işlevselliğini geliştirmek için Microsoft tarafından kullanılan izleme günlüklerinde görünür. Ancak, diğer meta veri ayrıntıları ve değerleri korumalı müşteri verilerinizdir.

  1. Azure portalında API merkezinize gidin.

  2. Soldaki menüde, Varlıklar'ın altında Meta Veriler > + Yeni meta veriler'i seçin.

  3. Ayrıntılar sekmesinde meta veriler hakkındaki bilgileri girin.

    1. Başlık alanına İş kolu yazın.

    2. İsteğe bağlı olarak bir Açıklama girin.

    3. Önceden tanımlanmış seçenekler yazın ve Pazarlama, Finans, BT, Satış gibi seçenekler girin. İsteğe bağlı olarak Birden çok değerin seçilmesine izin ver'i etkinleştirin. İleri'yi seçin.

    Portala özel meta veri ekleme işleminin ekran görüntüsü.

  4. Atamalar sekmesinde API'ler için gerekli'yi seçin. Dağıtımlar ve Ortamlar için İsteğe Bağlı'ya tıklayın. (Bu varlıkları sonraki öğreticilerde ekleyeceksiniz.) İleri'yi seçin.

    Portaldaki meta veri atamalarının ekran görüntüsü.

  5. Gözden geçir ve oluştur sekmesinde ayarları gözden geçirin ve Oluştur'u seçin.

    Meta veriler, Meta Veriler sayfasındaki listeye eklenir.

  6. Başka bir örnek eklemek için + Yeni meta veriler'i seçin.

  7. Ayrıntılar sekmesinde meta veriler hakkındaki bilgileri girin.

    1. Başlık alanına Genel kullanıma yönelik yazın.

    2. Boole türü'nü seçin.

  8. Atamalar sekmesinde API'ler için gerekli'yi seçin. Dağıtımlar ve Ortamlar için geçerli değil'i seçin.

  9. Gözden geçir ve oluştur sekmesinde ayarları gözden geçirin ve Oluştur'u seçin.

    Meta veriler listeye eklenir.

Meta veri şemasını görüntüleme

API merkezinizde tanımlanan meta veriler için JSON şemasını görüntüleyebilir ve indirebilirsiniz. Şema yerleşik ve özel meta veriler içerir.

  1. Soldaki menüde, Varlıklar'ın altında Meta Veri > Görünümü meta veri şeması'nı seçin.

  2. Yerleşik ve özel meta veriler içeren API'lerin meta veri şemasını görmek için Meta veri şeması > API'lerini görüntüle'yi seçin. API merkezinizdeki dağıtımlar ve ortamlar için tanımlanan meta veri şemasını da görüntüleyebilirsiniz.

    Portaldaki meta veri şemasının ekran görüntüsü.

Sonraki adımlar

Bu öğreticide portalı kullanarak şunları yapmayı öğrendiniz:

  • API merkezinizde özel meta veriler tanımlama
  • Meta veri şemasını görüntüleme

Meta veri şemanızı hazırladığınıza göre API'leri API merkezinizdeki envantere ekleyin.