Langkah 6: Memublikasikan API

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Pada langkah ini, Anda akan memublikasikan API ke portal dengan melakukan langkah-langkah berikut:
1. Buat Spesifikasi OpenAPI
2. Membuat proxy API dari spesifikasi
3. Buat produk API
4. Memublikasikan API ke portal Anda

Langkah 1: Buat Spesifikasi OpenAPI

Setiap Spesifikasi OpenAPI berfungsi sebagai sumber tepercaya selama siklus proses API. Spesifikasi yang sama digunakan di setiap fase dalam siklus proses API, mulai dari pengembangan hingga publikasi.

Untuk membuat Spesifikasi OpenAPI:

  1. Pilih Develop > Specs di menu navigasi sebelah kiri untuk membuka halaman Specs.
  2. Klik + Spec > Import URL.
  3. Masukkan informasi berikut di dialog impor:
  4. Nama impor: helloworld

  5. URL Impor: https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml

  6. Klik Impor.

Langkah 2: Buat Proxy API dari spesifikasi

Buat proxy API dari Spesifikasi OpenAPI yang mendeskripsikan API.

Untuk membuat proxy API dari Spesifikasi OpenAPI:

  1. Di halaman Spesifikasi, posisikan kursor di atas spesifikasi helloworld untuk menampilkan menu tindakan.
  2. Klik untuk membuat proxy API dari spesifikasi.
    Wizard Build a Proxy akan terbuka dan halaman Details diisi otomatis menggunakan nilai dari Spesifikasi OpenAPI.
  3. Edit kolom Deskripsi sebagai berikut: Proxy API untuk hello world.
  4. Klik Berikutnya.

  5. 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

  6. Klik Berikutnya.

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

  8. Di halaman Virtual Hosts, pastikan semua virtual host dipilih, lalu klik Next.

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

  10. Klik Buat.

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

Langkah 3: Buat produk API

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

Untuk membuat produk API:

  1. Pilih Publikasi > Produk API di menu navigasi sebelah kiri untuk membuka halaman Produk API.
  2. Klik + API Product.
    Halaman Produk Baru 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 4: 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 API resource, klik Add a proxy untuk mengidentifikasi proxy API yang akan ditambahkan ke produk API Anda.
    Dialog Add API Resource akan ditampilkan.
  5. Klik API Proxy (jika belum dipilih) dan pilih Mock-Target-API dalam daftar.
  6. Klik Tambahkan.
  7. Klik Simpan untuk menyimpan produk API.

    Produk Hello World API yang menampilkan semua kolom yang ditetapkan

Langkah 4: Publikasikan API ke portal Anda

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

Untuk memublikasikan API ke portal Anda:

  1. 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 Katalog API 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.

  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 Spesifikasi Saya (jika belum dipilih).
    4. Pilih helloworld dari daftar spesifikasi.
    5. Klik Pilih.
  6. Klik Simpan untuk menyimpan detail API.

    Hello World API yang menampilkan semua kolom yang ditetapkan

Untuk melihat dokumentasi referensi API:

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

Mock Target API yang dipublikasikan dengan panel Coba API ini

Selamat! Anda telah berhasil menyelesaikan tutorial. Siap untuk mempelajari lebih lanjut? Buka Membuat portal terintegrasi.