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 Anda

Langkah 1: Membuat Proxy API dari spesifikasi

Buat proxy API dari Spesifikasi OpenAPI yang mendeskripsikan API.

Untuk membuat proxy API dari Spesifikasi OpenAPI:

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

  2. Klik Buat Baru.
    Menambahkan proxy API

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

  3. Di bagian Reverse Proxy (paling umum), klik Use OpenAPI Spec. Menggunakan 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 Pilih.
    Wizard Create Proxy akan terbuka dan halaman Proxy details diisi otomatis menggunakan nilai dari Spesifikasi OpenAPI.

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

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

  7. Klik Berikutnya.

  8. Di halaman Kebijakan:

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

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

  9. Klik Berikutnya.

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

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

  12. Klik Buat dan deploy.

Di halaman Ringkasan, Anda akan melihat konfirmasi bahwa proxy API baru 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 Publikasikan > Produk API di menu navigasi sebelah kiri untuk membuka halaman Produk API.
  2. Klik +CREATE.
    Halaman Produk akan ditampilkan.
  3. Masukkan Detail Produk untuk produk API Anda.
    Catatan: Kolom Nama Tampilan dan Deskripsi ditampilkan di portal saat Anda memublikasikan produk API, secara default. Anda dapat mengedit nilai di Langkah 3: Memublikasikan API ke portal.
    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)
  4. Di bagian Operations, klik ADD AN OPERATION untuk mengidentifikasi operasi yang akan ditambahkan ke produk API Anda.
  5. Di bagian Sumber, klik Proxy API, lalu pilih Mock-Target-API dari menu drop-down.
  6. Di bagian Operasi, masukkan garis miring (/) di kolom Jalur. Abaikan kolom lainnya.
  7. Klik Simpan untuk menyimpan Operasi.
  8. Dialog Tambahkan Operasi akan ditampilkan. Menambahkan proxy API Mock-Target-API di dialog Tambahkan Operasi
  9. Klik Tambahkan.
  10. Klik Simpan.

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 Publikasi > Portal di menu navigasi sebelah kiri.
    2. Klik baris Portal pertama saya untuk membuka portal.
    3. Klik API Catalog untuk menampilkan halaman API.
  2. Klik +.
  3. Pilih Hello World di dialog Tambahkan produk API ke katalog, lalu klik Berikutnya.
  4. Di bagian API details, konfigurasikan 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 di dialog Select image.
      3. Klik Pilih.
      4. Lihat pratinjau gambar, lalu klik Pilih.
    • Untuk Kategori, masukkan Mulai dan tekan Enter.

    Biarkan semua nilai lainnya ditetapkan ke setelan 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 Pilih Dokumen.
    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 Pilih.

    Bagian dokumentasi API saat menambahkan API ke portal

  6. Klik Simpan.

Untuk melihat dokumentasi referensi API:

  1. Di UI Apigee, klik Live Portal untuk melihat perubahan di portal aktif (atau muat ulang portal aktif jika sudah terbuka di tab lain).
  2. Di portal live:
    a. Klik APIs 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 yang dipublikasikan dengan panel Coba API ini