Bagikan melalui

Menggunakan Azure CLI untuk mengelola inventori API Anda

  • Artikel

Artikel ini memperlihatkan cara menggunakan az apic api perintah di Azure CLI untuk menambahkan dan mengonfigurasi API di inventarisasi pusat API Anda. Gunakan perintah di Azure CLI untuk operasi skrip untuk mengelola inventarit API Dan aspek lain dari pusat API Anda.

Prasyarat

  • Pusat API di langganan Azure Anda. Jika Anda belum membuatnya, lihat Mulai Cepat: Membuat pusat API Anda.

  • Untuk Azure CLI:

    Catatan

    az apic perintah memerlukan apic-extension ekstensi Azure CLI. Jika Anda belum menggunakan az apic perintah, ekstensi dapat diinstal secara dinamis saat Anda menjalankan perintah pertama az apic , atau Anda dapat menginstal ekstensi secara manual. Pelajari selengkapnya tentang ekstensi Azure CLI.

    Lihat catatan rilis untuk perubahan dan pembaruan terbaru di apic-extension. Fitur tertentu mungkin memerlukan pratinjau atau versi ekstensi tertentu.

Mendaftarkan API, versi API, dan definisi

Langkah-langkah berikut menunjukkan cara membuat API dan mengaitkan satu versi API dan definisi API. Untuk latar belakang tentang model data di Azure API Center, lihat Konsep utama.

Buat API

Gunakan perintah az apic api create untuk membuat API di pusat API Anda.

Contoh berikut membuat API bernama Petstore API di grup sumber daya myResourceGroup dan pusat API myAPICenter . API adalah REST API.

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

Membuat versi API

Gunakan perintah az apic api version create untuk membuat versi untuk API Anda.

Contoh berikut membuat versi API bernama v1-0-0 untuk API petstore-api yang Anda buat di bagian sebelumnya. Versi diatur ke tahap siklus hidup pengujian .

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"

Membuat definisi API dan menambahkan file spesifikasi

Gunakan perintah definisi api az apic untuk menambahkan definisi dan file spesifikasi yang menyertainya untuk versi API.

Membuat definisi

Contoh berikut menggunakan perintah az apic api definition create untuk membuat definisi bernama openapi untuk versi API petstore-api yang Anda buat di bagian sebelumnya.

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"

Mengimpor file spesifikasi

Impor file spesifikasi ke definisi menggunakan perintah az apic api definition import-specification .

Contoh berikut mengimpor file spesifikasi OpenAPI dari URL yang dapat diakses publik ke definisi openapi yang Anda buat di langkah sebelumnya. Properti name dan version sumber daya spesifikasi diteruskan sebagai JSON.

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"}'

Tip

Anda dapat mengimpor file spesifikasi sebaris dengan mengatur --format parameter ke inline dan meneruskan konten file menggunakan --value parameter .

Mengekspor file spesifikasi

Untuk mengekspor spesifikasi API dari pusat API Anda ke file lokal, gunakan perintah az apic api definition export-specification .

Contoh berikut mengekspor file spesifikasi dari definisi openapi yang Anda buat di bagian sebelumnya ke file lokal bernama specificationFile.json.

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"

Mendaftarkan API dari file spesifikasi - langkah tunggal

Anda dapat mendaftarkan API dari file spesifikasi lokal dalam satu langkah dengan menggunakan perintah az apic api register . Dengan opsi ini, versi dan definisi API default dibuat secara otomatis untuk API.

Contoh berikut mendaftarkan API di pusat API myAPICenter dari file definisi OpenAPI lokal bernama specificationFile.json.

az apic api register --resource-group myResourceGroup \
    --service-name myAPICenter --api-location "/Path/to/specificationFile.json"
  • Perintah mengatur properti API seperti nama dan jenis dari nilai dalam file definisi.
  • Secara default, perintah mengatur tahap Siklus Hidup API ke desain.
  • Ini membuat versi API bernama sesuai dengan version properti dalam definisi API (atau 1-0-0 secara default), dan definisi API bernama sesuai dengan format spesifikasi (misalnya, openapi).

Memperbarui properti API

Setelah mendaftarkan API, Anda dapat memperbarui properti API dengan menggunakan az apic api update, az apic api version update, dan az apic api definition update commands.

Contoh berikut memperbarui judul API petstore-api ke Petstore API v2.

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

Contoh berikut mengatur properti kustom internal Boolean API ke false.

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

Menghapus sumber daya API

Gunakan perintah az apic api delete untuk menghapus API dan semua versi dan sumber daya definisinya. Contohnya:

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

Untuk menghapus versi dan definisi API individual, gunakan az apic api version delete dan az apic api definition delete, masing-masing.

Konten terkait