Langkah 6: Memublikasikan API

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

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

Langkah 1: Membuat Spesifikasi OpenAPI

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

Untuk membuat Spesifikasi OpenAPI:

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

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

  6. Klik Import.

Langkah 2: Membuat Proxy API dari spesifikasi

Buat proxy API dari Spesifikasi OpenAPI yang mendeskripsikan API.

Untuk membuat proxy API dari Spesifikasi OpenAPI:

  1. Di halaman Specs, posisikan kursor Anda 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 akan diisi otomatis menggunakan nilai dari Spesifikasi OpenAPI.
  3. Edit kolom Description sebagai berikut: Proxy API untuk hello world.
  4. Klik Next.

  5. Di halaman Policies:

    • Di bagian Security: Authorization, pilih Pass through (no authorization).
    • Di bagian Security: Browser, pilih Add CORS headers .

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

  6. Klik Next.

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

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

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

  10. Klik Create.

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

Langkah 3: Membuat produk API

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

Untuk membuat produk API:

  1. Pilih Publish > API Products di menu navigasi kiri untuk membuka halaman API Products.
  2. Klik + API Product.
    Halaman produk baru akan ditampilkan.
  3. Masukkan Product Details 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 Anda.
    Kolom Nilai
    Nama Hello World
    Nama Tampilan Hello World
    Deskripsi Contoh hello world sederhana
    Lingkungan Pilih lingkungan tempat proxy API di-deploy.
    Akses Public
    Menyetujui permintaan akses secara otomatis Aktif
    Quota (kosongkan)
    Cakupan OAuth yang Diizinkan (kosongkan)
  4. Di bagian API resources, 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 Add.
  7. Klik Save untuk menyimpan produk API.

    Produk Halo Dunia API yang menampilkan semua kolom yang ditetapkan

Langkah 4: Memublikasikan API ke portal Anda

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

Untuk memublikasikan API ke portal Anda:

  1. Buka halaman APIs di portal Anda:
    1. Pilih Publish > Portals di menu navigasi kiri.
    2. Klik di baris My first portal untuk membuka portal.
    3. Klik API catalog untuk menampilkan halaman APIs.
  2. Klik +.
  3. Pilih Halo Dunia di dialog Add an API product to the catalog , lalu klik Next.
  4. Di bagian API details, konfigurasi opsi berikut:
    • Pilih Published (listed in the catalog) untuk memublikasikan API ke portal Anda.
    • Untuk Display image:
      1. Klik Select image.
      2. Klik home-background.jpg dari daftar gambar yang ada di dialog Select image.
      3. Klik Select.
      4. Lihat pratinjau gambar, lalu klik Select.
    • Untuk Categories, masukkan Get Started, lalu tekan Enter.

    Biarkan semua nilai lainnya ditetapkan ke nilai defaultnya.

  5. Di bagian dokumentasi API, untuk membuat dokumentasi referensi API secara otomatis dari snapshot Spesifikasi OpenAPI Anda:
    1. Pilih OpenAPI document.
    2. Klik Select Document.
    3. Pilih tab My Specs (jika belum dipilih).
    4. Pilih helloworld dari daftar spesifikasi.
    5. Klik Select.
  6. Klik Save untuk menyimpan detail API.

    Halo Dunia API yang menampilkan semua kolom yang ditetapkan

Untuk melihat dokumentasi referensi API:

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

Mock Target API yang dipublikasikan dengan panel Coba API ini

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