Panduan memulai: Mulai menggunakan Developer Knowledge API

Panduan ini menunjukkan cara memulai Developer Knowledge API. Anda akan mempelajari cara mengaktifkan Developer Knowledge API, mendapatkan kunci API, dan melakukan panggilan API pertama untuk menelusuri dan mengambil dokumentasi developer.

Sebelum memulai

Mengaktifkan API

  1. Buka halaman Developer Knowledge API di library API Google.
  2. Periksa apakah Anda telah memilih project yang benar untuk menggunakan API.
  3. Klik Enable. Tidak ada peran IAM tertentu yang diperlukan untuk mengaktifkan atau menggunakan API.

Membuat dan mengamankan kunci API

  1. Di Konsol Google Cloud untuk project tempat Anda mengaktifkan API, buka halaman Kredensial.
  2. Klik Create credentials, lalu pilih API key dari menu. Dialog API key created akan menampilkan string untuk kunci yang baru dibuat.
  3. Klik Edit kunci API.
  4. Di kolom Name, masukkan nama untuk kunci.
  5. Pada bagian Pembatasan API, pilih Batasi kunci.
  6. Dari daftar Select APIs, aktifkan Developer Knowledge API, lalu klik OK.
    • Catatan: Jika Anda baru saja mengaktifkan Developer Knowledge API, mungkin ada penundaan sebelum API tersebut muncul di daftar Select APIs.
  7. Klik Simpan.

Menelusuri bagian dokumen

Setelah memiliki kunci API Developer Knowledge, Anda dapat mulai menggunakan API. Contoh berikut menunjukkan cara menelusuri potongan dokumen yang terkait dengan "BigQuery":

  1. Simpan kunci API Developer Knowledge Anda ke variabel lingkungan:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    Ganti YOUR_API_KEY dengan kunci API yang Anda buat.

  2. Gunakan curl untuk memanggil endpoint searchDocumentChunks:

    curl "https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

Perintah ini menampilkan daftar potongan dokumen yang cocok dengan kueri, termasuk cuplikan dari konten dan parent untuk setiap dokumen.

Mengambil dokumen

Respons dari searchDocumentChunks berisi daftar potongan dokumen. Setiap bagian dokumen memiliki kolom parent, yang dapat Anda gunakan untuk mengambil seluruh konten dokumen dengan GetDocument.

Salin parent salah satu potongan dokumen yang ditampilkan oleh panggilan searchDocumentChunks (misalnya, documents/developers.google.com/...), simpan ke variabel lingkungan, dan gunakan curl untuk memanggil endpoint GetDocument:

export DOC_NAME="DOCUMENT_NAME"

curl "https://developerknowledge.googleapis.com/v1alpha/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

Tindakan ini akan menampilkan konten Markdown lengkap dari dokumen yang ditentukan.

Langkah berikutnya