API idaresi için meta verileri kullanma
Bu makalede meta veriler ve Azure API Center'da API idaresi için nasıl kullanılacağı hakkında arka plan sağlanır. API'leri ve API merkezinizdeki diğer varlıkları düzenlemek ve filtrelemek için meta verileri tanımlar ve ayarlarsınız. Meta veriler yerleşik veya özel olabilir ve API'leriniz, ortamlarınız ve dağıtımlarınız arasında tutarlılığı zorlamak için bir meta veri şeması geliştirebilirsiniz.
Yerleşik meta veriler
API merkezinizde API'leri, ortamları ve dağıtımları oluştururken veya güncelleştirirken, API türü (REST, WSDL vb.) gibi bazı yerleşik meta veri özelliklerini ayarlarsınız.
Aşağıdaki tablolarda, Azure API Center varlıkları için sağlanan yerleşik meta veriler listelenir. Ayrıntılar için bkz . API Center REST API başvurusu. Tablolar kaynak tanımlayıcıları, görüntüleme başlıkları ve açıklamalar gibi standart Azure özelliklerini içermez. Tüm özellikler gerekli değildir.
API'ler
| Meta veri | Açıklama | Örnek değerler |
|---|---|---|
| tür | API türü (türü) | REST, SOAP, GraphQL |
| yaşam döngüsü aşaması | API geliştirme yaşam döngüsünün aşaması | tasarım, geliştirme |
| lisans | API için lisans bilgileri | SPDX tanımlayıcısı, lisans metni bağlantısı |
| dış belgeler | API için dış belgeler için site | Belgelere işaret eden URL |
| iletişim bilgileri | API için iletişim noktaları | e-posta adresi, ad, URL |
| hizmet koşulları | API için hizmet koşulları | Hizmet koşullarına işaret eden URL |
Ortamlar
| Meta veri | Açıklama | Örnek değerler |
|---|---|---|
| tür | ortam türü (türü) | üretim, hazırlama, geliştirme |
| sunucu | ortamın sunucu bilgileri | tür ve ortam sunucusuna işaret eden URL |
| sunucu türü | ortam sunucusu türü | API Management sunucusu, Kubernetes sunucusu, Apigee sunucusu |
| ekleme | ortam için ekleme bilgileri | yönergeleri ve ortamın geliştirici portalına işaret eden URL |
Dağıtımlar
| Meta veri | Açıklama | Örnek değerler |
|---|---|---|
| sunucu | dağıtımın sunucu bilgileri | Dağıtım sunucusuna işaret eden URL |
| semt | dağıtımın durumu | etkin, etkin değil |
Özel meta veriler
API merkezinizdeki API'leri , ortamları ve dağıtımları düzenlemeye ve filtrelemeye yardımcı olmak için Azure portalını, Azure API Center REST API'sini veya Azure CLI'yı kullanarak özel meta veriler tanımlayın. Azure API Center aşağıdaki türlerdeki özel meta verileri destekler.
| Type | Açıklama | Örnek adı |
|---|---|---|
| boolean | true veya false | IsInternal |
| Numara | sayısal değer | YearOfCreation |
| Dize | metin değeri | GitHubRepository |
| dizi | değer listesi | Etiketler |
| yerleşik seçim | yerleşik seçenek listesi | Departman |
| nesne | birden çok türden oluşan karmaşık nesne | APIApprover |
Ö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.
Varlıklara meta veri atama
Özel meta veri özellikleri API'lere, ortamlara veya API merkezinizdeki dağıtımlara atanabilir. Örneğin, API'lere Departman meta verilerini tanımlayın ve atayın; böylece BIR API kaydedildiğinde veya yeni bir API sürümü eklendiğinde API'nin sorumlu bölümü belirtilir.
Bir varlığa atandıysa, meta veriler isteğe bağlıdır veya gereklidir. Örneğin, Departman meta verilerinin yalnızca API'ler için ayarlanmasını zorunlu kılabilir, ancak YearOfCreation'ın ortamlar için isteğe bağlı meta veriler olmasını isteyebilirsiniz.
Not
- İstediğiniz zaman özel meta veriler tanımlayın ve API'lere ve API merkezinizdeki diğer varlıklara uygulayın.
- Özel meta verileri tanımladıktan sonra, örneğin API'ler için gerekli yerine isteğe bağlı olarak bir varlığa atamasını değiştirebilirsiniz.
- Meta veri değerlerini değiştirebilirsiniz, ancak şu anda API'lerde, ortamlarda ve dağıtımlarda ayarlanmış olan özel meta verilerin türünü silemez veya değiştiremezsiniz. Önce varlıklardaki özel meta verilerin atamasını kaldırın ve ardından bunları silebilir veya değiştirebilirsiniz.
İdare için meta verileri kullanma
API'lerinizi, ortamlarınızı ve dağıtımlarınızı API merkezinizde düzenlemek için yerleşik ve özel meta verileri kullanın. Örneğin:
API'ler, ortamlar ve dağıtımlar için belirli meta verilerin ayarlanmasını gerektirerek kuruluşunuzda idare standartlarını zorunlu kılın.
API merkezinizdeki API'leri meta veri değerlerine göre arayın ve filtreleyin. Api'leri belirli meta verilerin değerlerine göre sorgulamak için doğrudan Azure portalındaki API'ler sayfasında filtreleyebilir veya Azure API Center REST API'sini veya Azure CLI'yı kullanabilirsiniz.
