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. Membuat Spesifikasi OpenAPI
2. Buat proxy API dari spesifikasi
3. Membuat produk API
4. Memublikasikan API ke portal

Langkah 1: Buat Spesifikasi OpenAPI

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

Untuk membuat Spesifikasi OpenAPI:

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

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

  6. Klik Import.

Langkah 2: Buat Proxy API dari spesifikasi

Buat proxy API dari Spesifikasi OpenAPI yang menjelaskan API.

Untuk membuat proxy API dari Spesifikasi OpenAPI:

  1. Di halaman Spesifikasi, posisikan kursor ke spesifikasi helloworld untuk menampilkan menu tindakan.
  2. Klik untuk menghasilkan proxy API dari spesifikasi tersebut.
    Wizard Build a Proxy akan terbuka dan halaman Detail 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 Kebijakan:

    • Di bagian Keamanan: Otorisasi, pilih Teruskan (tanpa otorisasi).
    • Pada Security: Browser, pilih Add CORS headers .

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

  6. Klik Next.

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

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

  9. Pada halaman Summary, pilih lingkungan tempat Anda ingin melakukan deployment di bagian Optional Deployment.

  10. Klik Create.

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

Langkah 3: Membuat produk API

Buat produk API yang berisi resource API yang ingin ditampilkan kepada konsumen API.

Untuk membuat produk API:

  1. Pilih Publish > API Products di menu navigasi sebelah kiri untuk membuka halaman API Products.
  2. Klik + Produk API.
    Halaman Produk Baru akan ditampilkan.
  3. Masukkan Detail Produk untuk produk API Anda.
    Catatan: Secara default, kolom Nama Tampilan dan Deskripsi ditampilkan di portal saat Anda memublikasikan produk API. Anda dapat mengedit nilai di Langkah 4: Publikasikan API ke portal.
    Kolom Nilai
    Nama Halo Dunia
    Nama Tampilan Halo Dunia
    Deskripsi Contoh halo dunia sederhana
    Lingkungan Pilih lingkungan tempat proxy API di-deploy.
    Akses Umum
    Menyetujui permintaan akses secara otomatis Aktif
    Kuota (biarkan kosong)
    Cakupan OAuth yang Diizinkan (biarkan kosong)
  4. Di bagian API resources, klik Add a proxy untuk mengidentifikasi proxy API yang akan ditambahkan ke produk API.
    Dialog Add API Resource akan ditampilkan.
  5. Klik API Proxy (jika belum dipilih), lalu pilih Mock-Target-API dalam daftar.
  6. Klik Tambahkan.
  7. Klik Save untuk menyimpan produk API.

    Produk Hello World API yang menampilkan semua kolom ditetapkan

Langkah 4: Publikasikan API ke portal Anda

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

Untuk memublikasikan API ke portal:

  1. Buka halaman API di portal Anda:
    1. Pilih Publikasikan > 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 dalam dialog Add an API product to the catalog, lalu klik Next.
  4. Di bagian Detail API, 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 dalam dialog Select image.
      3. Klik Pilih.
      4. Lihat pratinjau gambar, lalu klik Pilih.
    • Untuk Kategori, masukkan Mulai, lalu tekan Enter.

    Tetap gunakan nilai default untuk setelan lainnya.

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

    Hello World API yang menampilkan semua kolom 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. Cobalah API Anda.

Mock Target API dipublikasikan dengan panel Coba API ini

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