Aracılığıyla paylaş

API envanterinizi yönetmek için Azure CLI'yi kullanma

  • Makale

Bu makalede, API merkezi envanterinize API'ler eklemek ve yapılandırmak için Azure CLI'daki komutların nasıl kullanılacağı az apic api gösterilmektedir. API envanterinizi ve API merkezinizin diğer yönlerini yönetmek üzere işlemleri betik olarak kullanmak için Azure CLI'daki komutları kullanın.

Önkoşullar

  • Azure aboneliğinizde bir API merkezi. Henüz oluşturmadıysanız bkz . Hızlı Başlangıç: API merkezinizi oluşturma.

  • Azure CLI için:

    • Azure Cloud Shell'de Bash ortamını kullanın. Daha fazla bilgi için bkz . Azure Cloud Shell'de Bash için hızlı başlangıç.

    • CLI başvuru komutlarını yerel olarak çalıştırmayı tercih ediyorsanız Azure CLI'yı yükleyin . Windows veya macOS üzerinde çalışıyorsanız Azure CLI’yi bir Docker kapsayıcısında çalıştırmayı değerlendirin. Daha fazla bilgi için bkz . Docker kapsayıcısında Azure CLI'yi çalıştırma.

      • Yerel yükleme kullanıyorsanız az login komutunu kullanarak Azure CLI ile oturum açın. Kimlik doğrulama işlemini tamamlamak için terminalinizde görüntülenen adımları izleyin. Diğer oturum açma seçenekleri için bkz . Azure CLI ile oturum açma.

      • İstendiğinde, ilk kullanımda Azure CLI uzantısını yükleyin. Uzantılar hakkında daha fazla bilgi için bkz. Azure CLI ile uzantıları kullanma.

      • Yüklü sürümü ve bağımlı kitaplıkları bulmak için az version komutunu çalıştırın. En son sürüme yükseltmek için az upgrade komutunu çalıştırın.

    Not

    az apic komutları Için Azure CLI uzantısı gerekir apic-extension . Komutları kullanmadıysanız az apic , ilk az apic komutunuzu çalıştırdığınızda uzantı dinamik olarak yüklenebilir veya uzantıyı el ile yükleyebilirsiniz. Azure CLI uzantıları hakkında daha fazla bilgi edinin.

    içindeki en son değişiklikler ve güncelleştirmeler için sürüm notlarınıapic-extensioninceleyin. Bazı özellikler, uzantının önizlemesini veya belirli bir sürümünü gerektirebilir.

API' yi, API sürümünü ve tanımını kaydetme

Aşağıdaki adımlarda, BIR API'nin nasıl oluşturulacağı ve tek bir API sürümü ile API tanımının nasıl ilişkilendirilecekleri gösterilmektedir. Azure API Center'da veri modeli hakkında arka plan için bkz . Temel kavramlar.

API oluşturma

API merkezinizde bir API oluşturmak için az apic api create komutunu kullanın.

Aşağıdaki örnek, myResourceGroup kaynak grubunda ve myAPICenter API merkezinde Petstore API'si adlı bir API oluşturur. API bir REST API'dir.

az apic api create  --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --title "Petstore API" --type "rest"

API sürümü oluşturma

API'niz için bir sürüm oluşturmak için az apic api version create komutunu kullanın.

Aşağıdaki örnek, önceki bölümde oluşturduğunuz petstore-API API için v1-0-0 adlı bir API sürümü oluşturur. Sürüm, test yaşam döngüsü aşamasına ayarlanır.

az apic api version create --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --version-id v1-0-0 --title "v1-0-0" --lifecycle-stage "testing"

API tanımı oluşturma ve belirtim dosyası ekleme

API sürümü için bir tanım ve eşlik eden bir belirtim dosyası eklemek için az apic api definition komutlarını kullanın.

Tanım oluşturma

Aşağıdaki örnek, önceki bölümde oluşturduğunuz petstore-api API sürümü için openapi adlı bir tanım oluşturmak üzere az apic api definition create komutunu kullanır.

az apic api definition create --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --version-id v1-0-0 --definition-id openapi --title "OpenAPI"

Belirtim dosyasını içeri aktarma

az apic api definition import-specification komutunu kullanarak belirtim dosyasını tanıma aktarın.

Aşağıdaki örnek, genel olarak erişilebilen bir URL'den bir OpenAPI belirtim dosyasını önceki adımda oluşturduğunuz openapi tanımına aktarır. name Belirtim kaynağının ve version özellikleri JSON olarak geçirilir.

az apic api definition import-specification \
    --resource-group myResourceGroup --service-name myAPICenter \
    --api-id petstore-api --version-id v1-0-0 \
    --definition-id openapi --format "link" \
    --value 'https://petstore3.swagger.io/api/v3/openapi.json' \
    --specification '{"name":"openapi","version":"3.0.2"}'

İpucu

belirtim dosyasını satır içinde içeri aktarmak için inline parametresini --format ayarlayın ve parametresini --value kullanarak dosya içeriğini geçirin.

Belirtim dosyasını dışarı aktarma

API belirtimini API merkezinizden yerel bir dosyaya aktarmak için az apic api definition export-specification komutunu kullanın.

Aşağıdaki örnek, belirtim dosyasını önceki bölümde oluşturduğunuz openapi tanımından specificationFile.json adlı yerel bir dosyaya aktarır.

az apic api definition export-specification \
    --resource-group myResourceGroup --service-name myAPICenter \
    --api-id petstore-api --version-id v1-0-0 \
    --definition-id openapi --file-name "/Path/to/specificationFile.json"

API'leri belirtim dosyasından kaydetme - tek adım

Az apic api register komutunu kullanarak yerel belirtim dosyasından api'yi tek adımda kaydedebilirsiniz . Bu seçenekle, API için varsayılan BIR API sürümü ve tanımı otomatik olarak oluşturulur.

Aşağıdaki örnek, specificationFile.json adlı yerel bir OpenAPI tanım dosyasından myAPICenter API merkezine bir API kaydeder.

az apic api register --resource-group myResourceGroup \
    --service-name myAPICenter --api-location "/Path/to/specificationFile.json"
  • komutu, tanım dosyasındaki değerlerden ad ve tür gibi API özelliklerini ayarlar.
  • Varsayılan olarak, komut API'nin Yaşam Döngüsü aşamasını tasarım olarak ayarlar.
  • API tanımındaki version özelliğine göre (veya varsayılan olarak 1-0-0 ) adlı bir API sürümü ve belirtim biçimine göre (örneğin, openapi) adlı bir API tanımı oluşturur.

API özelliklerini güncelleştirme

API'yi kaydettikten sonra az apic api update, az apic api version update ve az apic api definition update komutlarını kullanarak API'nin özelliklerini güncelleştirebilirsiniz.

Aşağıdaki örnek, petstore-api API'sinin başlığını Petstore API v2 olarak güncelleştirir.

az apic api update --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --title "Petstore API v2"

Aşağıdaki örnek API'nin Boole iç özel özelliğini false olarak ayarlar.

az apic api update --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --set custom_properties.internal=false

API kaynaklarını silme

Bir API'yi ve tüm sürüm ve tanım kaynaklarını silmek için az apic api delete komutunu kullanın. Örneğin:

az apic api delete \
    --resource-group myResourceGroup --service-name myAPICenter \
    --api-id petstore-api

Tek tek API sürümlerini ve tanımlarını silmek için sırasıyla az apic api version delete ve az apic api definition delete kullanın.

İlgili içerik