คู่มือเริ่มต้นใช้งาน Java ฉบับย่อ

คู่มือการเริ่มต้นอย่างรวดเร็วนี้อธิบายวิธีตั้งค่าแอปพลิเคชันบรรทัดคำสั่ง Java อย่างง่ายที่ส่งคำขอไปยัง YouTube Data API คู่มือ เริ่มต้นฉบับย่อนี้อธิบายวิธีส่งคำขอ API 2 รายการ

  1. คุณจะใช้คีย์ API ซึ่งระบุแอปพลิเคชันของคุณเพื่อ ดึงข้อมูลเกี่ยวกับช่อง YouTube ของ GoogleDevelopers
  2. คุณจะใช้รหัสไคลเอ็นต์ OAuth 2.0 เพื่อส่งคำขอที่ได้รับอนุญาต ซึ่งดึงข้อมูลเกี่ยวกับช่อง YouTube ของคุณเอง

ข้อกำหนดเบื้องต้น

หากต้องการเรียกใช้การเริ่มต้นอย่างรวดเร็วนี้ คุณจะต้องมีสิ่งต่อไปนี้

  • Java 1.7 ขึ้นไป
  • Gradle 2.3 ขึ้นไป
  • การเข้าถึงอินเทอร์เน็ตและเว็บเบราว์เซอร์
  • บัญชี Google

ขั้นตอนที่ 1: ตั้งค่าโปรเจ็กต์และข้อมูลเข้าสู่ระบบ

สร้างหรือเลือกโปรเจ็กต์ในคอนโซล API ทํางานต่อไปนี้ใน API Console สําหรับโปรเจ็กต์ของคุณ

  1. ในแผงไลบรารี ให้ค้นหา YouTube Data API v3 คลิกข้อมูลของ API นั้นและตรวจสอบว่าได้เปิดใช้ API สำหรับโปรเจ็กต์ของคุณแล้ว

  2. ในแผงข้อมูลเข้าสู่ระบบ ให้สร้างข้อมูลเข้าสู่ระบบ 2 รายการดังนี้

    1. สร้างคีย์ API คุณจะใช้คีย์ API เพื่อส่งคำขอ API ที่ไม่จำเป็นต้องมีการให้สิทธิ์จากผู้ใช้ เช่น คุณไม่จำเป็นต้องมีการให้สิทธิ์จากผู้ใช้ เพื่อดึงข้อมูลเกี่ยวกับช่อง YouTube สาธารณะ

    2. สร้างรหัสไคลเอ็นต์ OAuth 2.0 ตั้งค่าประเภทแอปพลิเคชันเป็นอื่นๆ คุณต้องใช้ข้อมูลเข้าสู่ระบบ OAuth 2.0 สำหรับคำขอที่ต้องมีการให้สิทธิ์จากผู้ใช้ เช่น คุณต้องมีการให้สิทธิ์จากผู้ใช้เพื่อดึงข้อมูลเกี่ยวกับช่อง YouTube ของผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ในปัจจุบัน

      ดาวน์โหลดไฟล์ JSON ที่มีข้อมูลเข้าสู่ระบบ OAuth 2.0 ไฟล์มีชื่อ เช่น client_secret_CLIENTID.json โดยที่ CLIENTID คือรหัสไคลเอ็นต์ของโปรเจ็กต์

ขั้นตอนที่ 2: เตรียมโปรเจ็กต์

ทําตามขั้นตอนต่อไปนี้เพื่อเตรียมโปรเจ็กต์ Gradle

  1. ในไดเรกทอรีที่ทำงานอยู่ ให้เรียกใช้คำสั่งต่อไปนี้เพื่อสร้างโครงสร้างโปรเจ็กต์ใหม่ 

    $ gradle init --type basic
$ mkdir -p src/main/java src/main/resources

  2. ย้ายไฟล์ JSON ที่คุณดาวน์โหลดหลังจากสร้างรหัสไคลเอ็นต์ OAuth 2.0 ไปยังไดเรกทอรี src/main/resources ใต้ไดเรกทอรีการทำงาน แล้ว เปลี่ยนชื่อไฟล์เป็น client_secret.json

  3. เปิดไฟล์ build.gradle ในไดเรกทอรีการทำงาน แล้วแทนที่เนื้อหาด้วยข้อมูลต่อไปนี้

    apply plugin: 'java'
apply plugin: 'application'

mainClassName = 'ApiExample'
sourceCompatibility = 1.7
targetCompatibility = 1.7
version = '1.0'

repositories {
    mavenCentral()
}

dependencies {
    compile 'com.google.api-client:google-api-client:1.23.0'
    compile 'com.google.oauth-client:google-oauth-client-jetty:1.23.0'
    compile 'com.google.apis:google-api-services-youtube:v3-revREVISION-CL_VERSION'
}

  4. ในไฟล์ build.gradle คุณต้องแทนที่ตัวแปร REVISION และ CL_VERSION ด้วยค่า 2 ค่าจาก เอกสารประกอบไลบรารีของไคลเอ็นต์ สำหรับ YouTube Data API ภาพหน้าจอด้านล่างซึ่งแสดงเอกสารประกอบสำหรับ YouTube Analytics API จะแสดงตำแหน่งที่ตัวแปร 2 รายการปรากฏในหน้าเว็บ

    ภาพหน้าจอของการอ้างอิง JavaDoc ที่แสดงวิธีค้นหามูลค่าสำหรับตัวแปร "REVISION" และ "CL_VERSION"

ขั้นตอนที่ 3: ตั้งค่าและเรียกใช้ตัวอย่าง

ใช้เครื่องมือสำรวจ API ในวิดเจ็ตแผงด้านข้างเพื่อรับโค้ดตัวอย่างสำหรับ การดึงข้อมูลเกี่ยวกับช่อง YouTube ของ GoogleDevelopers คำขอนี้ ใช้คีย์ API เพื่อระบุแอปพลิเคชันของคุณ และไม่จำเป็นต้องมีการให้สิทธิ์จากผู้ใช้ หรือสิทธิ์พิเศษใดๆ จากผู้ใช้ที่เรียกใช้ตัวอย่าง

  1. เปิดเอกสารประกอบสำหรับเมธอด channels.list ของ API

  2. ในหน้านั้น ส่วน "กรณีการใช้งานทั่วไป" จะมีตารางที่อธิบาย วิธีทั่วไปหลายวิธีในการใช้เมธอด ข้อมูลแรกในตาราง คือผลการแสดงข้อมูลตามรหัสช่อง

    คลิกสัญลักษณ์โค้ดสำหรับข้อมูลแรกเพื่อเปิดและป้อนข้อมูลใน โปรแกรมสำรวจ API แบบเต็มหน้าจอ

    รูปภาพที่ระบุตำแหน่งของลิงก์สัญลักษณ์โค้ดในตารางที่แสดงกรณีการใช้งานสำหรับเอกสารประกอบ channels.list ข้อความแสดงแทน ของรูปภาพนั้นจะระบุรูปภาพเป็นสัญลักษณ์โค้ดและระบุ กรณีการใช้งานที่เชื่อมโยงกับลิงก์นั้น

  3. ด้านซ้ายของโปรแกรมสำรวจ API แบบเต็มหน้าจอจะแสดงข้อมูลต่อไปนี้

    1. ใต้ส่วนหัวพารามิเตอร์คำขอจะมีรายการพารามิเตอร์ ที่เมธอดรองรับ ควรตั้งค่าพารามิเตอร์ part และ id idค่าพารามิเตอร์ UC_x5XG1OV2P6uZZ5FSM9Ttw คือ รหัสของช่อง YouTube ของ GoogleDevelopers

    2. ส่วนข้อมูลเข้าสู่ระบบจะอยู่ใต้พารามิเตอร์ เมนูแบบเลื่อนลงในส่วนนั้นควรแสดงค่า API key เครื่องมือสำรวจ API ใช้ข้อมูลเข้าสู่ระบบการสาธิตโดยค่าเริ่มต้นเพื่อให้เริ่มต้นใช้งานได้ง่ายขึ้น แต่คุณจะต้องใช้คีย์ API ของคุณเองเพื่อเรียกใช้ตัวอย่างในเครื่อง

      รูปภาพที่แสดง "ข้อมูลเข้าสู่ระบบ" ใน API Explorer แบบเต็มหน้าจอ และเมนูแบบเลื่อนลงที่เลือกตัวเลือก "คีย์ API"

  4. ด้านขวาของโปรแกรมสำรวจ API แบบเต็มหน้าจอจะแสดงแท็บที่มีตัวอย่างโค้ด ในภาษาต่างๆ เลือกแท็บ Java

  5. คัดลอกตัวอย่างโค้ดและบันทึกไว้ในไฟล์ชื่อ src/main/java/ApiExample.java ตัวอย่างทุกรายการใช้ชื่อคลาสเดียวกัน (ApiExample) เพื่อให้คุณไม่ ต้องแก้ไขไฟล์ build.gradle เพื่อเรียกใช้ตัวอย่างต่างๆ

  6. ในตัวอย่างที่คุณดาวน์โหลด ให้ค้นหาสตริง YOUR_API_KEY แล้ว แทนที่ด้วยคีย์ API ที่คุณสร้างในขั้นตอนที่ 1 ของการเริ่มต้นใช้งานฉบับย่อนี้

  7. เรียกใช้ตัวอย่างจากบรรทัดคำสั่ง ในไดเรกทอรีที่ใช้งานอยู่ ให้เรียกใช้คำสั่งต่อไปนี้

    gradle -q run

  8. ตัวอย่างควรดำเนินการตามคำขอและพิมพ์การตอบกลับไปยัง STDOUT

ขั้นตอนที่ 4: เรียกใช้คำขอที่ได้รับอนุญาต

ในขั้นตอนนี้ คุณจะต้องแก้ไขตัวอย่างโค้ดเพื่อให้ดึงข้อมูลเกี่ยวกับช่อง YouTube ของคุณแทนที่จะดึงข้อมูลเกี่ยวกับช่อง YouTube ของ GoogleDevelopers คำขอนี้ต้องมีการให้สิทธิ์จากผู้ใช้

  1. กลับไปที่เอกสารประกอบสำหรับเมธอด channels.list ของ API

  2. ในส่วน "กรณีการใช้งานทั่วไป" ให้คลิกสัญลักษณ์โค้ดสำหรับรายการที่ 3 ในตาราง กรณีการใช้งานดังกล่าวคือการเรียกใช้เมธอด list สำหรับ "ช่องของฉัน"

  3. อีกครั้งที่ด้านซ้ายของโปรแกรมสำรวจ API แบบเต็มหน้าจอ คุณจะเห็น รายการพารามิเตอร์ตามด้วยส่วนข้อมูลเข้าสู่ระบบ อย่างไรก็ตาม มีการเปลี่ยนแปลง 2 อย่างจากตัวอย่างที่คุณดึงข้อมูลเกี่ยวกับช่อง GoogleDevelopers

    1. ในส่วนพารามิเตอร์ ค่าพารามิเตอร์ id ควรตั้งค่าเป็น true แทนที่จะตั้งค่าเป็น mine ซึ่งจะสั่งให้เซิร์ฟเวอร์ API ดึงข้อมูลเกี่ยวกับช่องของผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ในปัจจุบัน

    2. ในส่วนข้อมูลเข้าสู่ระบบ เมนูแบบเลื่อนลงควรเลือกตัวเลือกสำหรับ Google OAuth 2.0

      นอกจากนี้ หากคุณคลิกลิงก์แสดงขอบเขต คุณควรเลือกขอบเขต https://www.googleapis.com/auth/youtube.readonly

      รูปภาพที่แสดงขอบเขตในโปรแกรมสำรวจ API แบบเต็มหน้าจอและ ตัวเลือกในการใช้ข้อมูลเข้าสู่ระบบ "Google OAuth 2.0" ที่เลือก

  4. เช่นเดียวกับตัวอย่างก่อนหน้า ให้เลือกแท็บ Java คัดลอกตัวอย่างโค้ด แล้วบันทึกลงใน src/main/java/ApiExample.java

  5. เรียกใช้ตัวอย่างจากบรรทัดคำสั่ง ในไดเรกทอรีที่ใช้งานอยู่ ให้เรียกใช้คำสั่งต่อไปนี้

    gradle -q run

  6. ตัวอย่างควรพยายามเปิดหน้าต่างหรือแท็บใหม่ในเบราว์เซอร์เริ่มต้น หากไม่สำเร็จ ให้คัดลอก URL จากเทอร์มินัลแล้วเปิดด้วยตนเอง ในเบราว์เซอร์

    หากยังไม่ได้เข้าสู่ระบบบัญชี Google ระบบจะแจ้งให้คุณเข้าสู่ระบบ หากลงชื่อเข้าใช้บัญชี Google หลายบัญชี ระบบจะขอให้คุณเลือกบัญชีที่จะใช้สำหรับการให้สิทธิ์

  7. คลิกปุ่มเพื่อให้สิทธิ์เข้าถึงขอบเขตที่ระบุใน ตัวอย่างโค้ดแก่แอปพลิเคชัน

  8. ระบบจะดำเนินการกับตัวอย่างโดยอัตโนมัติ และคุณสามารถปิดแท็บเบราว์เซอร์ ที่ใช้สำหรับโฟลว์การให้สิทธิ์ได้

    การตอบกลับของ API ควรพิมพ์ไปยัง STDOUT อีกครั้ง

อ่านเพิ่มเติม