Halaman ini berlaku untuk Apigee dan Apigee Hybrid.
Pengguna dengan izin administrator dapat mengupload file markdown dan gambar untuk menyampaikan informasi penting yang relevan dengan desain, pengembangan, deployment, atau penggunaan API tertentu. Panduan ditampilkan sebagai versi konten markdown yang dirender. Jika tidak ada panduan yang diupload, Anda akan diminta untuk mengupload konten.
Format file
Untuk pratinjau pribadi, hanya file ZIP yang didukung.
File ZIP dapat berisi file markdown dan gambar.
Harus ada file index.md yang berfungsi sebagai halaman landing. Jika tidak ada
file index.md yang disertakan dalam file zip, pesan error yang menunjukkan bahwa
file index.md diperlukan akan ditampilkan dan upload dibatalkan.
Link absolut dan relatif diizinkan.
Direktori panduan API:
https://console.cloud.google.com/apigee/apihub/apis/{api}/guide/index.md
Header Markdown dirender dengan tag anchor yang sesuai untuk memungkinkan penautan dalam dokumen. Contoh:
https://console.cloud.google.com/apigee/apihub/apis/{api}/guide/contact.md#on_call
Upload file zip
Upload file zip untuk menambahkan panduan baru atau menimpa pedoman perusahaan yang sudah ada.
Untuk mengupload file ZIP:
Di Cloud Console, buka halaman API hub.
Halaman daftar APIs ditampilkan secara default.
- Dari daftar API atau My APIs, klik baris API. Tab Overview ditampilkan secara default.
- Pilih tab Panduan.
- Lakukan salah satu hal berikut:
- Tambahkan baru: Klik Upload untuk mengupload file zip baru.
- Timpa yang ada: Klik Ganti yang ada untuk mengupload file zip dan menimpa konten yang ada.
- Klik Lanjutkan (atau Batal) saat diminta.
Hapus semua konten
Untuk menghapus semua konten yang ada:
Di Cloud Console, buka halaman API hub.
Halaman daftar APIs ditampilkan secara default.
- Dari daftar API atau My APIs, klik baris API. Tab Overview ditampilkan secara default.
- Pilih tab Panduan.
- Klik Hapus semua.
- Klik Hapus (atau Batalkan) saat diminta.
Apa langkah selanjutnya?
Mengelola panduan API perusahaan