Tutorial: Mendaftarkan API di inventarisasi API Anda

Dalam tutorial ini, mulai inventarisasi API di pusat API organisasi Anda dengan mendaftarkan API dan menetapkan metadata menggunakan portal Azure.

Untuk informasi latar belakang tentang API, versi API, definisi, dan entitas lain yang dapat Anda inventarisasi di Azure API Center, lihat Konsep utama.

Dalam tutorial ini, Anda mempelajari cara menggunakan portal untuk:

Prasyarat

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

• Satu atau beberapa API yang ingin Anda daftarkan di pusat API Anda. Berikut adalah dua contoh, dengan tautan ke definisi OpenAPI mereka:

  • Swagger Petstore API
  • API Konferensi

• Selesaikan tutorial sebelumnya, Tentukan metadata kustom, untuk menentukan metadata kustom untuk API Anda.

Mendaftarkan API

Saat Anda mendaftarkan (menambahkan) API di pusat API Anda, pendaftaran API meliputi:

• Judul (nama), jenis, dan deskripsi
• Informasi versi
• Tautan opsional ke dokumentasi dan kontak
• Metadata bawaan dan kustom yang Anda tentukan

Setelah mendaftarkan API, Anda dapat menambahkan versi dan definisi ke API.

Langkah-langkah berikut mendaftarkan dua sampel API: Swagger Petstore API dan Conference API (lihat Prasyarat). Jika mau, daftarkan API Anda sendiri.

1. Di portal, navigasikan ke pusat API Anda.

2. Di menu sebelah kiri, di bawah Aset, pilih API>+ Daftarkan API.

3. Di halaman Daftarkan API , tambahkan informasi berikut untuk API Swagger Petstore. Anda akan melihat metadata Lini bisnis dan Publik kustom yang Anda tentukan dalam tutorial sebelumnya di bagian bawah halaman.

   Pengaturan	Nilai	Deskripsi
   Judul API	Masukkan API Swagger Petstore.	Nama yang Anda pilih untuk API.
   Identifikasi	Setelah Anda memasukkan judul sebelumnya, Azure API Center menghasilkan pengidentifikasi ini, yang dapat Anda ambil alih.	Nama sumber daya Azure untuk API.
   Tipe API	Pilih REST dari menu dropdown.	Jenis API.
   Ringkasan	Secara opsional masukkan ringkasan.	Deskripsi ringkasan API.
   Keterangan	Secara opsional masukkan deskripsi.	Deskripsi API.
   Versi
   Judul versi	Masukkan judul versi pilihan Anda, seperti v1.	Nama yang Anda pilih untuk versi API.
   Identifikasi versi	Setelah Anda memasukkan judul sebelumnya, Azure API Center menghasilkan pengidentifikasi ini, yang dapat Anda ambil alih.	Nama sumber daya Azure untuk versi tersebut.
   Siklus hidup versi	Buat pilihan dari menu dropdown, misalnya, Pengujian atau Produksi.	Tahap siklus hidup versi API.
   Dokumentasi eksternal	Secara opsional tambahkan satu atau beberapa tautan ke dokumentasi eksternal.	Nama, deskripsi, dan URL dokumentasi untuk API.
   Lisensi	Secara opsional tambahkan informasi lisensi.	Nama, URL, dan ID lisensi untuk API.
   Informasi kontak	Secara opsional tambahkan informasi untuk satu atau beberapa kontak.	Nama, email, dan URL kontak untuk API.
   Lini bisnis	Jika Anda menambahkan metadata ini di tutorial sebelumnya, buat pilihan dari menu dropdown, seperti Pemasaran.	Metadata kustom yang mengidentifikasi unit bisnis yang memiliki API.
   Menghadap publik	Jika Anda menambahkan metadata ini, pilih kotak centang.	Metadata kustom yang mengidentifikasi apakah API menghadap publik atau internal saja.

   

4. Pilih Buat. API terdaftar.

5. Ulangi tiga langkah sebelumnya untuk mendaftarkan API lain, seperti Api Konferensi.

API muncul di halaman API di portal. Saat Anda telah menambahkan sejumlah besar API ke pusat API, gunakan kotak pencarian dan filter di halaman ini untuk menemukan API yang Anda inginkan.

Setelah mendaftarkan API, Anda dapat melihat atau mengedit properti API. Pada halaman API , pilih API untuk melihat halaman untuk mengelola pendaftaran API.

Menambahkan versi API

Sepanjang siklus hidupnya, API dapat memiliki beberapa versi. Anda dapat menambahkan versi ke API yang ada di pusat API Anda, secara opsional dengan file definisi atau file.

Di sini Anda menambahkan versi ke salah satu API Anda:

1. Di portal, navigasikan ke pusat API Anda.

2. Di menu sebelah kiri, pilih API, lalu pilih API, misalnya, Swagger Petstore.

3. Pada halaman API, di bawah Detail, pilih Versi>+ Tambahkan versi.

   

4. Pada halaman Tambahkan versi API:

   1. Masukkan atau pilih informasi berikut:

      Pengaturan	Nilai	Deskripsi
      Judul versi	Masukkan judul versi pilihan Anda, seperti v2.	Nama yang Anda pilih untuk versi API.
      Identifikasi versi	Setelah Anda memasukkan judul sebelumnya, Azure API Center menghasilkan pengidentifikasi ini, yang dapat Anda ambil alih.	Nama sumber daya Azure untuk versi tersebut.
      Siklus hidup versi	Buat pilihan dari menu dropdown, seperti Produksi.	Tahap siklus hidup versi API.

   2. Pilih Buat. Versi ditambahkan.

Menambahkan definisi ke versi Anda

Biasanya Anda ingin menambahkan definisi API ke versi API Anda. Azure API Center mendukung definisi dalam format spesifikasi teks umum, seperti OpenAPI 2 dan 3 untuk REST API.

Untuk menambahkan definisi API ke versi Anda:

1. Pada halaman Versi API Anda, pilih versi API Anda.

2. Di menu sebelah kiri versi API Anda, di bawah Detail, pilih Definisi>+ Tambahkan definisi.

3. Pada Halaman Tambahkan definisi:

   1. Masukkan atau pilih informasi berikut:

      Pengaturan	Nilai	Deskripsi
      Judul	Masukkan judul pilihan Anda, seperti Definisi v2.	Nama yang Anda pilih untuk definisi API.
      Identifikasi	Setelah Anda memasukkan judul sebelumnya, Azure API Center menghasilkan pengidentifikasi ini, yang dapat Anda ambil alih.	Nama sumber daya Azure untuk definisi.
      Keterangan	Secara opsional masukkan deskripsi.	Deskripsi definisi API.
      Nama spesifikasi	Untuk API Petstore, pilih OpenAPI.	Format spesifikasi untuk API.
      Versi spesifikasi	Masukkan pengidentifikasi versi pilihan Anda, seperti 3.0.	Versi spesifikasi.
      Surat	Telusuri ke file definisi lokal untuk API Petstore, atau masukkan URL. CONTOH URL: https://raw.githubusercontent.com/swagger-api/swagger-petstore/refs/heads/master/src/main/resources/openapi.yaml	File definisi API.

      

   2. Pilih Buat. Definisi ditambahkan.

Dalam tutorial ini, Anda mempelajari cara menggunakan portal untuk:

Saat Anda membangun inventarisasi API, manfaatkan alat otomatis untuk mendaftarkan API, seperti ekstensi Azure API Center untuk Visual Studio Code dan Azure CLI.

Langkah berikutnya

Inventori API Anda mulai terbentuk! Sekarang Anda dapat menambahkan informasi tentang lingkungan dan penyebaran API.