Memublikasikan API (versi asli)

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

Publikasikan API ke portal Anda agar tersedia untuk digunakan oleh developer aplikasi, seperti yang dijelaskan di bagian berikut.

Ringkasan publikasi API

Proses publikasi API ke portal Anda merupakan proses dua langkah:

1. Pilih produk API yang ingin dipublikasikan ke portal Anda.
2. Buat otomatis dokumentasi referensi API dari snapshot Spesifikasi OpenAPI Anda agar developer aplikasi dapat mempelajari API Anda. (Untuk mengetahui informasi selengkapnya tentang snapshot, lihat Apa yang dimaksud dengan snapshot Spesifikasi OpenAPI?

Saat Anda memublikasikan API ke portal, update berikut akan otomatis diterapkan ke portal:

• Halaman Referensi API ditambahkan ke portal Anda
  Halaman Referensi API menampilkan dokumentasi referensi API yang Anda buat secara otomatis dari snapshot Spesifikasi OpenAPI Anda. Developer dapat meninjau dokumentasi API Anda dan mengklik Coba untuk membuat permintaan API dan melihat outputnya.

  Catatan: Anda tidak dapat mengedit konten halaman ini secara langsung; konten tidak akan muncul dalam daftar halaman di portal Anda.

  

• Link ke halaman Referensi API ditambahkan ke halaman API
  Halaman API (disertakan dengan portal contoh) menyediakan daftar semua API yang dipublikasikan ke portal Anda beserta link ke masing-masing dokumentasi referensi API untuk mengetahui informasi selengkapnya.

  Catatan: Anda tidak dapat mengedit konten halaman ini secara langsung; konten tidak akan muncul dalam daftar halaman di portal Anda.

  

Apa yang dimaksud dengan snapshot Spesifikasi OpenAPI?

Setiap Spesifikasi OpenAPI berfungsi sebagai sumber kebenaran di sepanjang siklus proses API. Spesifikasi yang sama digunakan di setiap fase dalam siklus proses API, mulai dari pengembangan, publikasi, hingga pemantauan. Saat memodifikasi spesifikasi, Anda harus memahami dampak perubahan tersebut terhadap API melalui fase siklus proses lainnya, seperti yang dijelaskan dalam Apa yang terjadi jika saya memodifikasi spesifikasi?

Saat memublikasikan API, Anda akan mengambil snapshot Spesifikasi OpenAPI untuk menghasilkan dokumentasi referensi API. Snapshot tersebut mewakili versi spesifikasi tertentu di penyimpanan spesifikasi. Jika Anda memodifikasi Spesifikasi OpenAPI menggunakan editor spesifikasi, Anda dapat memutuskan untuk mengambil snapshot spesifikasi lainnya guna mencerminkan perubahan terbaru dalam dokumentasi referensi API.

Menambahkan dukungan CORS ke proxy API Anda

Sebelum memublikasikan API, Anda perlu menambahkan dukungan CORS ke proxy API untuk mendukung permintaan lintas origin sisi klien.

CORS (Cross-origin resource sharing) adalah mekanisme standar yang memungkinkan panggilan XMLHttpRequest (XHR) JavaScript yang dieksekusi di halaman web untuk berinteraksi dengan resource dari domain non-origin. CORS adalah solusi yang umumnya diimplementasikan untuk kebijakan asal yang sama yang diterapkan oleh semua browser. Misalnya, jika Anda melakukan panggilan XHR ke Twitter API dari kode JavaScript yang dieksekusi di browser Anda, panggilan akan gagal. Hal ini dikarenakan domain yang menayangkan halaman ke browser Anda tidak sama dengan domain yang menayangkan Twitter API. CORS menyediakan solusi atas masalah ini dengan mengizinkan server untuk "memilih ikut serta" jika ingin menyediakan berbagi resource lintas asal.

Untuk informasi tentang cara menambahkan dukungan CORS ke proxy API sebelum memublikasikan API, lihat Menambahkan dukungan CORS ke proxy API.

Catatan: Sebagian besar browser modern menerapkan CORS. Tinjau daftar lengkap browser yang didukung. Untuk deskripsi mendalam tentang CORS, lihat Rekomendasi W3C Cross-Origin Resource Sharing.

Menjelajahi halaman API

Untuk mengakses halaman API:

1. Pilih Publikasikan > Portal, lalu pilih portal Anda.
2. Klik API di halaman beranda portal.

Atau, Anda dapat memilih API di menu drop-down portal pada menu navigasi atas.

Daftar API ditampilkan.

Seperti yang disorot dalam gambar sebelumnya, halaman API memungkinkan Anda untuk:

• Lihat detail API yang tersedia di portal Anda
• Menambahkan API ke portal
• Mengambil snapshot Spesifikasi OpenAPI yang terkait dengan produk API untuk memperbarui dokumentasi referensi API
• Memublikasikan atau membatalkan publikasi API di portal
• Mengelola audiens untuk API di portal
• Mengedit spesifikasi terkait (lihat Membuat spesifikasi menggunakan editor spesifikasi)
• Menghapus API dari portal
• Identifikasi dengan cepat API "usang" yang produk API terkaitnya telah dihapus dari Edge, dan buat ulang produk API atau hapus API dari portal Anda

Menambahkan API ke portal

Catatan: Anda dapat menambahkan maksimum 100 API ke portal.

Untuk menambahkan API ke portal:

1. Pilih Publikasikan > Portal, lalu pilih portal Anda.
2. Klik API di halaman beranda portal.
   Atau, Anda dapat memilih API di menu drop-down portal pada menu navigasi atas.
3. Klik + API.
   Dialog Tambahkan Produk API ke Portal akan ditampilkan.

4. Pada tab Produk API dalam dialog, pilih produk API yang ingin ditambahkan ke portal Anda.
   

5. Klik Next.

6. Pilih sumber yang akan digunakan untuk snapshot.
   Jika Anda membuat proxy API yang disertakan dalam produk API menggunakan Spesifikasi OpenAPI, pilih spesifikasi dari menu drop-down.
   

   Atau, Anda dapat memilih:

   • Tidak ada spesifikasi dan tambahkan satu spesifikasi nanti setelah API dipublikasikan, seperti dijelaskan dalam Mengambil cuplikan spesifikasi.
   • Pilih spesifikasi yang berbeda untuk memilih atau mengupload spesifikasi baru.

7. Pilih kotak centang Dipublikasikan untuk memublikasikan API ke portal Anda. Batalkan pilihan Dipublikasikan jika Anda belum siap memublikasikan API.
   Anda dapat mengubah setelan nanti, seperti yang dijelaskan dalam Memublikasikan atau membatalkan publikasi API di portal.

8. Di bagian Audiens, pilih salah satu opsi berikut guna mengelola audiens untuk API Anda dengan mengizinkan akses ke:

   • Pengguna anonim untuk mengizinkan semua pengguna melihat halaman.
   • Pengguna terdaftar untuk hanya mengizinkan pengguna terdaftar melihat halaman.

   Anda dapat mengubah setelan nanti, seperti yang dijelaskan dalam Mengelola audiens untuk API di portal.

9. Klik Selesai.

Mengambil snapshot spesifikasi

Setelah memublikasikan API, Anda dapat mengambil snapshot baru Spesifikasi OpenAPI kapan saja untuk memperbarui dokumentasi referensi API yang dipublikasikan di portal.

Untuk mengambil snapshot Spesifikasi OpenAPI:

1. Pilih Publikasikan > Portal, lalu pilih portal Anda.
2. Klik API di halaman beranda portal.
   Atau, Anda dapat memilih API di menu drop-down portal pada menu navigasi atas.
3. Posisikan kursor di atas API yang ingin Anda ambil snapshot-nya untuk menampilkan tindakan.

4. Klik .

   Catatan: Pesan akan ditampilkan jika snapshot Anda saat ini dengan spesifikasi sumber yang dipilih.

5. Pilih spesifikasi yang ada dari drop-down Sumber Snapshot atau pilih Pilih spesifikasi yang berbeda untuk memilih atau mengupload spesifikasi baru yang akan digunakan untuk membuat dokumentasi untuk API. Atau, Anda dapat memilih Tidak ada spesifikasi untuk menghapus spesifikasi saat ini.

6. Klik Update Snapshot (atau Hapus Snapshot, jika Anda telah memilih No Spec).

Dokumentasi referensi API dihasilkan dari spesifikasi dan ditambahkan ke halaman Referensi API.

Memublikasikan atau membatalkan publikasi API di portal

Untuk memublikasikan atau membatalkan publikasi API di portal Anda:

1. Pilih Publikasikan > Portal, lalu pilih portal Anda.
2. Klik API di halaman beranda portal.
   Atau, Anda dapat memilih API di menu drop-down portal pada menu navigasi atas.
3. Posisikan kursor di atas API yang ingin dipublikasikan atau dibatalkan publikasinya.
4. Klik .
5. Pilih kotak centang Diaktifkan untuk memublikasikan API di portal Anda. Batalkan pilihan Enabled untuk membatalkan publikasi API.
6. Klik Simpan.

Mengelola audiens untuk API di portal

Kelola audiens untuk API di portal dengan mengizinkan akses ke:

• Semua pengguna
• Khusus pengguna terdaftar

Untuk mengelola audiens untuk API di portal Anda:

1. Pilih Publikasikan > Portal, lalu pilih portal Anda.
2. Klik API di halaman beranda portal.
   Atau, Anda dapat memilih API di menu drop-down portal pada menu navigasi atas.
3. Posisikan kursor di atas API yang audiensnya ingin Anda kelola untuk menampilkan tindakan.
4. Klik .
5. Di bagian Audiens, pilih salah satu opsi berikut:
   • Pengguna anonim untuk mengizinkan semua pengguna melihat produk API.
   • Pengguna terdaftar untuk hanya mengizinkan pengguna terdaftar melihat produk API.
6. Klik Simpan.

Menghapus API dari portal Anda

Untuk menghapus API dari portal Anda:

1. Pilih Publikasikan > Portal, lalu pilih portal Anda.
2. Klik API di halaman beranda portal.
   Atau, Anda dapat memilih API di menu drop-down portal pada menu navigasi atas.
3. Posisikan kursor di atas API dalam daftar untuk menampilkan menu tindakan.
4. Klik .

Memecahkan masalah pada API yang dipublikasikan

Saat menggunakan Coba, jika error TypeError: Failed to fetch ditampilkan, pertimbangkan kemungkinan penyebab dan solusi berikut:

• Untuk error konten campuran, error tersebut mungkin disebabkan oleh masalah swagger-ui umum. Salah satu solusinya adalah memastikan bahwa Anda menentukan HTTPS sebelum HTTP dalam definisi schemes di Spesifikasi OpenAPI Anda. Contoh:

   schemes:
     - https
     - http
  

• Untuk error pembatasan CORS (Cross-origin resource sharing), pastikan CORS didukung untuk proxy API Anda. CORS adalah mekanisme standar yang mengaktifkan permintaan lintas origin sisi klien. Lihat Menambahkan dukungan CORS untuk proxy API. Pastikan juga CORS in diaktifkan di browser Anda.