การเริ่มต้นอย่างรวดเร็ว: เริ่มต้นใช้งาน Developer Knowledge API

คู่มือนี้จะแสดงวิธีเริ่มต้นใช้งาน Developer Knowledge API คุณจะได้เรียนรู้วิธี เปิดใช้ Developer Knowledge API, รับคีย์ API และทำการเรียก API ครั้งแรกเพื่อค้นหาและดึงข้อมูลเอกสารประกอบสำหรับนักพัฒนาซอฟต์แวร์

ก่อนเริ่มต้น

เปิดใช้ API

  1. เปิดหน้า Developer Knowledge API ในไลบรารี Google APIs
  2. ตรวจสอบว่าคุณได้เลือกโปรเจ็กต์ที่ถูกต้องซึ่งคุณต้องการใช้ API
  3. คลิกเปิดใช้ ไม่จำเป็นต้องมีบทบาท IAM ที่เฉพาะเจาะจงเพื่อเปิดใช้หรือใช้ API

สร้างและรักษาคีย์ API ให้ปลอดภัย

  1. ในคอนโซล Google Cloud สำหรับโปรเจ็กต์ที่คุณเปิดใช้ API ให้ไปที่หน้าข้อมูลเข้าสู่ระบบ
  2. คลิกสร้างข้อมูลเข้าสู่ระบบ แล้วเลือกคีย์ API จากเมนู
  3. ระบุชื่อคีย์ในช่องชื่อ
  4. คลิกเมนูแบบเลื่อนลงเลือกการจำกัด API แล้วพิมพ์ Developer Knowledge API คลิกผลการค้นหา แล้วคลิก OK
    • หมายเหตุ: หากเพิ่งเปิดใช้ Developer Knowledge API ระบบอาจใช้เวลาสักพักก่อนที่ API จะปรากฏในรายการ โปรดรอสักครู่แล้วลองอีกครั้ง
  5. คลิกสร้าง

ค้นหาเอกสารแบบเป็นกลุ่ม

เมื่อได้คีย์ API สำหรับความรู้ของนักพัฒนาแล้ว คุณจะเริ่มใช้ API ได้ ตัวอย่างต่อไปนี้แสดงวิธีค้นหา Chunk ของเอกสารที่เกี่ยวข้องกับ "BigQuery"

  1. บันทึกคีย์ API ของ Developer Knowledge ลงในตัวแปรสภาพแวดล้อม

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    แทนที่ YOUR_API_KEY ด้วยคีย์ API ที่คุณสร้างขึ้น

  2. ใช้ curl เพื่อโทรไปยังปลายทาง searchDocumentChunks

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

คำสั่งนี้จะแสดงรายการของกลุ่มเอกสารที่ตรงกับการค้นหา รวมถึงข้อมูลโค้ดจากเนื้อหาและ parent สำหรับแต่ละเอกสาร

ดึงข้อมูลเอกสาร

การตอบกลับจาก searchDocumentChunks มีรายการก้อนเอกสาร แต่ละก้อนเอกสารจะมีฟิลด์ parent ซึ่งคุณใช้เพื่อดึงเนื้อหาทั้งหมดของเอกสารด้วย GetDocument ได้

คัดลอก parent ของก้อนเอกสารรายการใดรายการหนึ่งที่การเรียก searchDocumentChunks ส่งคืน (เช่น documents/developers.google.com/...) บันทึกลงในตัวแปรสภาพแวดล้อม และใช้ curl เพื่อเรียกปลายทาง GetDocument

export DOC_NAME="DOCUMENT_NAME"

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

ฟังก์ชันนี้จะแสดงผลเนื้อหา Markdown ทั้งหมดของเอกสารที่ระบุ

ขั้นตอนถัดไป