Kelola panduan API perusahaan

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Pengguna dengan izin administrator dapat mengupload file markdown dan gambar untuk menyampaikan informasi umum yang relevan dengan desain, pengembangan, deployment, atau penggunaan semua API di registry perusahaan. 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/guidelines/index.md

Header Markdown dirender dengan tag anchor yang sesuai untuk memungkinkan penautan dalam dokumen. Contoh:

https://console.cloud.google.com/apigee/apihub/guidelines/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:

  1. Di Konsol Cloud, buka halaman API hub, API Guidelines.

    Buka panduan API

  2. 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.
  3. Klik Lanjutkan (atau Batal) saat diminta.

Hapus semua konten

Untuk menghapus semua konten yang ada:

  1. Di Konsol Cloud, buka halaman API hub, API Guidelines.

    Buka panduan API

  2. Klik Hapus semua.
  3. Klik Hapus (atau Batalkan) saat diminta.

Apa langkah selanjutnya?

Mengelola panduan API tertentu