Langkah 6: Memublikasikan API

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Lihat dokumentasi Apigee Edge.

Pada langkah ini, Anda akan memublikasikan API ke portal dengan melakukan langkah-langkah berikut:

  1. Membuat proxy API dari spesifikasi
  2. Membuat produk API
  3. Memublikasikan API ke portal Anda

Langkah 1: Buat Proxy API dari spesifikasi

Buat proxy API dari Spesifikasi OpenAPI yang mendeskripsikan API.

Untuk membuat proxy API dari Spesifikasi OpenAPI:

  1. Di konsol Apigee di Cloud, buka halaman Proxy Development > API proxies.

    Buka proxy API

  2. Klik Buat. Wizard Create a proxy akan terbuka dan meminta Anda memilih jenis proxy API yang akan dibuat.

  3. Klik di kotak Proxy template.

  4. Klik OpenAPI spec template, Reverse Proxy (most common).

  5. Buka file berikut di browser, lalu simpan: 

    https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml

  6. Di Step 1 OpenAPI Specs, klik Browse.

  7. Buka file Spesifikasi OpenAPI yang baru saja Anda download, pilih, lalu klik Open.

  8. Klik Berikutnya.

  9. Di Step 2 Proxy details, kolom akan diisi otomatis menggunakan nilai dari Spesifikasi OpenAPI. Edit kolom Description sebagai berikut: API proxy for hello world.

  10. Klik Berikutnya.

  11. Di Step 3 Flows, pilih semua operasi.

  12. Klik Berikutnya.

  13. Di Step 4 Deploy, pilih lingkungan tempat Anda ingin melakukan deployment.

  14. Klik Oke.

  15. Klik Buat.

Saat proxy di-deploy, kolom Status di bagian Deployments akan menampilkan ikon hijau untuk menunjukkan bahwa revisi proxy API telah di-deploy. Anda dapat mengarahkan kursor ke ikon status untuk melihat informasi selengkapnya tentang deployment.

Langkah 2: Buat produk API

Buat produk API yang berisi resource API yang ingin Anda ekspos ke konsumen API Anda.

Untuk membuat produk API:

  1. Di konsol Apigee di Cloud, buka halaman Distribution > API products.

    Buka produk API

  2. Klik Buat. Halaman Product details akan ditampilkan. Masukkan Detail Produk untuk produk API Anda.

    Kolom Nilai
    Nama Halo Dunia
    Nama Tampilan Halo Dunia
    Deskripsi Contoh hello world sederhana
    Lingkungan Pilih lingkungan tempat proxy API di-deploy.
    Akses Public
    Menyetujui permintaan akses secara otomatis Enabled
    Kuota (biarkan kosong)
    Cakupan OAuth yang Diizinkan (biarkan kosong)

  3. Di bagian Operations, klik Add an operation untuk mengidentifikasi operasi yang akan ditambahkan ke produk API Anda.

    • Di bagian Source, pilih API proxy, lalu pilih Mock-Target-API dari drop-down.
    • Di bagian Operation, masukkan garis miring (/) di kolom Path. Abaikan kolom lainnya.

  4. Klik Save untuk menyimpan operasi.

  5. Klik Simpan untuk menyimpan produk.

Langkah 3: Publikasikan API ke portal Anda

Publikasikan API ke portal Anda agar pelanggan dapat mempelajari dan menggunakannya.

Untuk memublikasikan API ke portal Anda:

  1. Di konsol Apigee di Cloud, buka halaman Distribution > Portals.

    Buka Portal

  2. Klik baris My first portal untuk membuka portal.

  3. Klik tab APIs.

  4. Klik + API.

  5. Untuk API product, pilih Hello World.

  6. Pilih Dipublikasikan (tercantum dalam katalog) untuk memublikasikan API ke portal Anda.

  7. Untuk Judul tampilan, masukkan Hello World.

  8. Untuk Tampilkan gambar, klik Pilih.

  9. Klik Aset.

  10. Klik Pratinjau untuk home-background.jpg.

  11. Klik Pilih.

  12. Untuk dokumentasi API, guna membuat dokumentasi referensi API secara otomatis dari snapshot Spesifikasi OpenAPI Anda:

    1. Pilih OpenAPI document.
    2. Klik Pilih.
    3. Klik tab URL.
    4. Ketik helloworld di kolom Spec name.
    5. Salin dan tempel URL berikut di kolom URL: 
      https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
    6. Klik Pilih.

  13. Klik Simpan.

Langkah 4: Lihat dokumentasi referensi API

Untuk melihat dokumentasi referensi API:

  1. Di UI Apigee, klik Live Portal untuk melihat perubahan di portal live (atau muat ulang portal live jika sudah terbuka di tab lain).
  2. Di portal live:
    1. Klik API di menu navigasi atas untuk melihat API yang dipublikasikan.
    2. Klik kartu Hello World untuk melihat dokumentasi referensi API.
    3. Coba API Anda.

Mock Target API yang dipublikasikan dengan panel Coba API ini