Extending the WordPress REST API

Presented by Jirayu Yingthawornsuk

การเขียน REST route/endpoint เพิ่มเติมจากที่เวิร์ดเพรสเตรียมเอาไว้อยู่แล้ว พร้อมการทำ Authentication ด้วย JWT (JSON Web Token) สำหรับนำเวิร์ดเพรสไปใช้เป็น REST Server สำหรับแอพแบบเต็มตัว

---

Video: https://wordpress.tv/2017/03/28/jirayu-yingthawornsuk-extending-the-wordpress-rest-api/

Transcript

1. Extends WordPress REST API Jirayu Yingthawornsuk
2. วางโค้ดไว้ที่ไหน? • แนะนำให้เขียนปลั๊กอินสำหรับโค้ดโดยเฉพาะ • สามารถเขียนใส่ functions.php ของธีมได้เช่นกัน
3. โครงปลั๊กอิน GitHub Repository: 
 https://github.com/IronGhost63/ExtendsWordPressREST ดาวน์โหลด หรือโคลนให้เรียบร้อย
 $ git clone https://github.com/IronGhost63/ExtendsWordPressREST.git
4. เพิ่มรูทใหม่ให้ REST API
5. ฮุคแอคชัน เพิ่มรูทใหม่ผ่านฮุค rest_api_init
6. register_rest_route() ฟังก์ชันสำหรับสร้างรูทใหม่ register_rest_route($namespace, $route, $args, $override);
7. $namespace และ $route $namespace เป็นเหมือนสลักแบ่ง API
 $route เป็นเส้นทางคำสั่งของ API ยกตัวอย่าง https://tyria.in.th/api/v1/posts api/v1 คือ $namespace
 /posts คือ $route การมี namespace ช่วยให้สร้าง API หลายตัวหรือหลายเวอร์ชันบนโดเมน เดียวกันได้สะดวกขึ้น
8. $route (ต่อ) $route รับค่าเป็น Regular Expression เช่น “/posts/(?P<post_title>\w+)” โดยค่าที่จับได้จะถูกส่งให้ฟังก์ชันคอลแบ็คด้วย
9. $args อาร์กิวเมนต์สำหรับรูทที่เพิ่มใหม่ • methods กำหนด HTTP Method สำหรับรูทที่เพิ่มใหม่ • callback ฟังก์ชันที่จะทำงานเมื่อรูทถูกเรียกใช้งาน • permission_callback ฟังก์ชันตรวจสอบสิทธิ์การเข้าถึง • args อาร์กิวเมนต์ที่จะรับมาพร้อมรีเควสท์
10. $args methods ระบุได้หลายเมธ็อด คั่นด้วยคอมม่า หรือ เรียกผ่าน Constant จากคลาส WP_REST_Server เช่น WP_REST_Server::READABLE สำหรับ เมธ็อดอ่านข้อมูลทั้งหมด
11. $override ถ้าหากมีรูทดังกล่าวอยู่แล้ว จะทับการทำงานหรือไม่ ระบุค่าเป็น TRUE/FALSE เท่านั้น
12. สรุปโค้ดตัวอย่าง เพิ่มเอ็นด์พอยต์ /wc/v1/posts เมื่อถูกเรียกผ่าน GET จะเรียกใช้ฟังก์ชัน api_get_posts()
13. ฟังก์ชันที่ทำงานเมื่อเรียกรูทที่เพิ่มไว้
14. คอลแบ็ค api_get_posts() 1. เรียกใช้ฟังก์ชัน api_get_posts() เมื่อมี GET /wc/v1/posts 2. ฟังก์ชันรับ $request ที่เป็น WP_REST_Request เข้ามา 3. ฟังก์ชันประมวลผลข้อมูล เก็บข้อมูลลง $data 4. ส่งออพเจ็กท์ WP_REST_Response กลับออกไป
15. คอลแบ็คที่มี Request Parameter *ไม่รู้ว่าเรียกถูกหรือไม่ ด่าได้แต่อย่าแรง* • หากมีการส่ง Request Parameter เข้า มาด้วย สามารถเรียกใช้ได้ผ่าน $request[‘<param>’] • พารามิเตอร์อื่นๆ เช่นจาก $_POST หรือ $_GET ก็เรียกผ่าน $request ได้เช่นกัน
16. Authentication
17. Built-in Authentication Method • Cookies Authentication
18. Authentication Methods by Plugins • Basic Authentication • Application Password • OAuth 1.0a • JSON Web Token
19. JSON Web Token (JWT)
20. การทำงานของ JWT • ส่ง Username/Password กลับไปหาเซิร์ฟเวอร์ • เซิร์ฟเวอร์ส่ง Token กลับมาให้ • แนบ Token นี้ไปกับ Request ที่ส่งไปหาเซิร์ฟเวอร์
21. ติดตั้งปลั๊กอิน JWT ดาวน์โหลดและติดตั้ง JWT Authentication for WP REST API https://wordpress.org/plugins/jwt-authentication-for-wp-rest-api/ อย่าลืมตั้งค่าการทำงานของปลั๊กอินตามคำอธิบายของปลั๊กอิน
22. การขอ Token จากเซิร์ฟเวอร์ ส่ง POST Request ไปยัง /jwt-auth/v1/token พร้อมพารามิเตอร์ username และ password
23. การขอ Token จากเซิร์ฟเวอร์ ส่ง POST Request ไปยัง 
 /jwt-auth/v1/token พร้อม พารามิเตอร์ username และ password หาก Username/Password ถูกต้อง เซิร์ฟเวอร์จะส่งเพย์โหลดกลับมาพร้อม Token
24. การ Authenticate Request ใน request ใดๆ ที่ต้องเป็นสมาชิกถึงเข้า ถึงได้ ให้ส่ง Authorization ระบุ Value เป็น Bearer <Token> ไปใน Header
25. Authentication บนรูทที่เขียนเพิ่ม เขียนฟังก์ชันเรียกใช้คลาส Jwt_Auth_Public แล้ว Authenticate ผ่าน เมธ็อด validate_token()
26. Authentication บนรูทที่เขียนเพิ่ม เรียกใช้ฟังก์ชันดังกล่าวใน permission_callback ตอนที่ register_rest_route()
27. จบแล้ว บาย ❤
28. Jirayu Yingthawornsuk “เล่น Guild Wars 2 ให้เล่นเซิร์ฟ Northern Shiverpeaks”