Langkah 6: Memublikasikan API

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca 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

Langkah 1: Buat Proxy API dari spesifikasi

Buat proxy API dari Spesifikasi OpenAPI yang menjelaskan API.

Untuk membuat proxy API dari Spesifikasi OpenAPI:

  1. Di UI Apigee, pilih Develop > API proxy di menu navigasi sebelah kiri untuk membuka halaman proxy API.

  2. Klik Create New.
    Tambahkan proxy API

    Wizard Create Proxy akan terbuka dan meminta Anda untuk memilih jenis proxy API yang akan dibuat.

  3. Di bagian Reverse Proxy (paling umum), klik Use OpenAPI Spec. Gunakan Spesifikasi OpenAPI

    Dialog Use OpenAPI Spec akan ditampilkan.

  4. Salin dan tempel URL berikut di kolom OpenAPI Spec URL pada tab URL:

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

  5. Klik Select.
    Wizard Create Proxy akan terbuka dan halaman Detail proxy diisi otomatis menggunakan nilai dari Spesifikasi OpenAPI.

    Halaman detail proxy di wizard Create Proxy, yang telah diisi otomatis dengan konten

  6. Edit kolom Description sebagai berikut: Proxy API untuk hello world.

  7. Klik Next.

  8. Di halaman Kebijakan:

    • Di bagian Keamanan: Otorisasi, pilih Lewati (tanpa otorisasi).
    • Di bagian Keamanan: Browser, pilih Tambahkan header CORS .

    Halaman kebijakan umum di wizard Create Proxy dengan header Teruskan dan Tambahkan CORS dipilih

  9. Klik Next.

  10. Di halaman Flows, pastikan semua operasi dipilih, lalu klik Next.
    Membangun Alur Proxy

  11. Pada halaman Summary, pilih lingkungan tempat Anda ingin men-deploy di bagian Optional Deployment.

  12. Klik Buat dan deploy.

Di halaman Summary, Anda akan melihat konfirmasi bahwa proxy API baru Anda berhasil dibuat dan di-deploy ke lingkungan yang dipilih.

Langkah 2: Buat produk API

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

Untuk membuat produk API:

  1. Di UI Apigee, pilih Publish > API Products di menu navigasi sebelah kiri untuk membuka halaman API Products.
  2. Klik +CREATE.
    Halaman Produk akan ditampilkan.
  3. Masukkan Detail Produk untuk produk API Anda.
    Catatan: Kolom Display Name dan Description ditampilkan di portal saat Anda memublikasikan produk API secara default. Anda dapat mengedit nilai ini di Langkah 3: Publikasikan API ke portal 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 Aktif
    Kuota (biarkan kosong)
    Cakupan OAuth yang Diizinkan (biarkan kosong)
  4. Di bagian Operasi, klik TAMBAHKAN OPERASI untuk mengidentifikasi operasi yang akan ditambahkan ke produk API Anda.
  5. Di bagian Source, klik API proxy dan pilih Mock-Target-API dari drop-down.
  6. Pada Operation, masukkan garis miring (/) di kolom Path. Abaikan kolom lainnya.
  7. Klik Save untuk menyimpan Operasi.
  8. Dialog Add Operation akan ditampilkan. Menambahkan proxy API Mock-Target-API dalam dialog Add Operation
  9. Klik Tambahkan.
  10. Klik Save.

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 UI Apigee, buka halaman API di portal Anda:
    1. Pilih Publikasikan > Portal di menu navigasi sebelah kiri.
    2. Klik di baris Portal pertama saya untuk membuka portal.
    3. Klik Katalog API untuk menampilkan halaman API.
  2. Klik +.
  3. Pilih Hello World dalam dialog Add an API product to the catalog, lalu klik Next.
  4. Di bagian Detail API, konfigurasi opsi berikut:
    • Pilih Dipublikasikan (tercantum dalam katalog) untuk memublikasikan API ke portal Anda.
    • Untuk Gambar tampilan:
      1. Klik Pilih gambar.
      2. Klik home-background.jpg dari daftar gambar yang ada pada dialog Select image.
      3. Klik Select.
      4. Lihat pratinjau gambar, lalu klik Pilih.
    • Untuk Kategori, masukkan Mulai, lalu tekan Enter.

    Biarkan semua nilai lain disetel ke default.

    Bagian detail API saat menambahkan API ke portal

  5. Di bagian Dokumentasi API, untuk membuat dokumentasi referensi API secara otomatis dari snapshot Spesifikasi OpenAPI Anda:
    1. Pilih Dokumen OpenAPI.
    2. Klik Select Document.
    3. Pilih tab Impor dari URL.
    4. Masukkan helloworld di kolom Spec name.
    5. Salin dan tempel URL berikut di kolom URL, lalu tekan Enter: 
      https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
    6. Klik Select.

    Bagian dokumentasi API saat menambahkan API ke portal

  6. Klik Save.

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:
    a. Klik API di menu navigasi atas untuk melihat API yang dipublikasikan.
    b. Klik kartu Hello World untuk melihat dokumentasi referensi API.
    c. Coba API Anda!

Mock Target API dipublikasikan dengan panel Coba API ini