ก่อนที่จะเริ่มเขียนโค้ดแอปพลิเคชันไคลเอ็นต์แรก คุณต้องดำเนินการบางอย่างดังต่อไปนี้หากยังไม่ได้ทำ
สร้างบัญชี Google
คุณต้องมีบัญชี Google เพื่อสร้างโปรเจ็กต์ในคอนโซล Google API หากมีบัญชีอยู่แล้ว คุณก็พร้อมใช้งานได้
นอกจากนี้ คุณอาจต้องการบัญชี Google แยกต่างหากเพื่อวัตถุประสงค์ในการทดสอบด้วย
สร้างโปรเจ็กต์สำหรับไคลเอ็นต์
ก่อนที่จะส่งคำขอไปยัง Google Knowledge Graph Search API ได้ คุณต้องแจ้งให้ Google ทราบเกี่ยวกับไคลเอ็นต์และเปิดใช้งานการเข้าถึง API ดังกล่าว ซึ่งทำได้โดยใช้คอนโซล Google API เพื่อสร้างโปรเจ็กต์ หรือคอลเล็กชันการตั้งค่าที่มีชื่อและข้อมูลการเข้าถึง API ตลอดจนลงทะเบียนแอปพลิเคชันของคุณ
ในการเริ่มต้นใช้งาน Google Knowledge Graph Search API ก่อนอื่นคุณต้องใช้เครื่องมือการตั้งค่า ซึ่งจะนำทางคุณในการสร้างโปรเจ็กต์ในคอนโซล Google API และเปิดใช้ API ดังกล่าว
หากยังไม่ได้ดำเนินการ ให้สร้างคีย์ API ของแอปพลิเคชันโดยคลิกสร้างข้อมูลเข้าสู่ระบบ > คีย์ API จากนั้นมองหาคีย์ API ในส่วนคีย์ API
ดูข้อมูลพื้นฐานเกี่ยวกับ REST
คุณเรียกใช้ API ได้ 2 วิธี ดังนี้
- การส่งคำขอ HTTP และการแยกวิเคราะห์การตอบกลับ
- การใช้ไลบรารีของไคลเอ็นต์
หากตัดสินใจที่จะไม่ใช้ไลบรารีของไคลเอ็นต์ คุณจะต้องเข้าใจพื้นฐานของ REST
REST เป็นรูปแบบสถาปัตยกรรมซอฟต์แวร์ที่ให้แนวทางที่สะดวกและสอดคล้องกันในการขอและแก้ไขข้อมูล
คำว่า REST ย่อมาจาก "Representational State Transfer" ในบริบทของ Google API คำนี้หมายถึงการใช้คำกริยา HTTP เพื่อดึงและแก้ไขการแสดงข้อมูลที่ Google จัดเก็บไว้
ในระบบ RESTful ระบบจะจัดเก็บทรัพยากรในที่เก็บข้อมูล ไคลเอ็นต์จะส่งคำขอให้เซิร์ฟเวอร์ดำเนินการใดดำเนินการหนึ่ง (เช่น สร้าง เรียกข้อมูล อัปเดต หรือลบทรัพยากร) และเซิร์ฟเวอร์จะดำเนินการและส่งการตอบกลับ ซึ่งมักจะอยู่ในรูปแบบของการแสดงทรัพยากรที่ระบุ
ใน RESTful API ของ Google ไคลเอ็นต์จะระบุการดำเนินการโดยใช้คำกริยา HTTP เช่น POST, GET, PUT หรือ DELETE โดยจะระบุทรัพยากรด้วย URI ที่ไม่ซ้ำกันทั่วโลกในรูปแบบต่อไปนี้
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
เนื่องจากทรัพยากร API ทั้งหมดมี URI ที่เข้าถึงได้ผ่าน HTTP ที่ไม่ซ้ำกัน REST จึงเปิดใช้การแคชข้อมูลและได้รับการเพิ่มประสิทธิภาพให้ทำงานร่วมกับโครงสร้างพื้นฐานแบบกระจายของเว็บได้
คุณอาจพบว่าคำจำกัดความของเมธอดในเอกสารประกอบมาตรฐาน HTTP 1.1 มีประโยชน์ ซึ่งรวมถึงข้อกำหนดสำหรับ GET, POST, PUT และ DELETE
REST ใน Google Knowledge Graph Search API
การดำเนินการของ Google Knowledge Graph Search API จะแมปกับคำกริยา HTTP ของ REST โดยตรง
รูปแบบที่เฉพาะเจาะจงสำหรับ URI ของ Google Knowledge Graph Search API มีดังนี้
https://kgsearch.googleapis.com/v1/entities:search?query=your_query¶meters
ชุด URI ทั้งหมดที่ใช้สำหรับการดำเนินการที่รองรับแต่ละรายการใน API จะสรุปไว้ในเอกสารข้อมูลอ้างอิง Google Knowledge Graph Search API
ดูข้อมูลเบื้องต้นเกี่ยวกับ JSON
Google Knowledge Graph Search API จะแสดงข้อมูลในรูปแบบ JSON
JSON (JavaScript Object Notation) เป็นรูปแบบข้อมูลทั่วไปที่ไม่ขึ้นกับภาษา ซึ่งแสดงโครงสร้างข้อมูลที่กำหนดเองในรูปแบบข้อความอย่างง่าย สำหรับข้อมูลเพิ่มเติม โปรดดู json.org