วิธีทำ Web Service API อย่างง่าย สำหรับ Mobile Apps

วิธีทำ Web Service API อย่างง่าย สำหรับ Mobile Apps

วิธีทำ Web Service API อย่างง่าย สำหรับ Mobile Apps
ในขั้นตอนของการทำ Mobile Apps ทุก Platform ทั้ง iOS, Android หรือ Window Phone องค์ประกอบสำคัญอีกอย่างหนึ่งของการพัฒนาโมบายแอพพลิเคชั่นคือ การพัฒนา Web Service API ที่จะเป็นตัวกลางในการจัดการกับระบบข้อมูลภายในแอพลิเคชั่น ทั้งการรับ และการส่งข้อมูล

ในบทความนี้จะเป็นการทำตัวอย่าง พัฒนา api ด้วยภาษาพีเอชพีและใช้ codeigniter framework เป็นโครงสร้างหลักในการจัดการกับส่วนต่าง ๆ แบบง่าย ๆ ครับ

ทำโครงสร้างหลักของ API ด้วย Codeigniter

ก่อนอื่นให้ดาวน์โหลดและติดตั้ง codeigniter framework และให้ตั้งค่าตาม url ที่ท่านจะเรียกใช้งาน

• 1. สร้างไฟล์ core/Default_Controller สำหรับไฟล์นี้จะถูกสร้างไว้ในส่วน core ของ codeigniter จะเป็นส่วนที่ทำงานก่อนที่จะเรียกใช้เมธอดใด ๆ ใน service api ตัวอย่างเช่นการ authentication หรือการยืนยันตัวตน เพื่อความปลอดภัยพื้นฐานในการเข้าถึงข้อมูลต่าง ๆ ของแอพพลิเคชั่น ตัวอย่างโค๊ด
  
  
  application/core/Default_Controller
  class Default_Controller extends CI_Controller { function __construct() { parent::__construct(); if(!$this->authentication()){ exit(); } } public function authentication(){ // สร้างเงื่อนไขในการยืนยันตัวตน ก่อนจะเข้าถึงเมธอดทั้งหมดของ API // ถ้าทำ api สำหรับ mobile app ควรตรวจสอบด้วยว่า request นั้นมาจาก mobile หรือไม่ // ถ้ามาเป็น request ที่มาจากที่อื่น เช่น website ไม่ควรให้ผ่าน return true; } }

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

  class Default_Controller extends CI_Controller {      function __construct() {        parent::__construct();    if(!$this->authentication()){    exit();    }    }    public function authentication(){   // สร้างเงื่อนไขในการยืนยันตัวตน ก่อนจะเข้าถึงเมธอดทั้งหมดของ API           // ถ้าทำ api สำหรับ mobile app ควรตรวจสอบด้วยว่า request นั้นมาจาก mobile หรือไม่           // ถ้ามาเป็น request ที่มาจากที่อื่น เช่น website ไม่ควรให้ผ่าน   return true;    } }




• 2. สร้างไฟล์ libraries/HttpMessage จะเป็นไฟล์สำหรับเก็บข้อความแจ้งเตื่อนต่าง ๆ ทั้ง Error และ Success หรือเพื่อความปลอดภัย อาจจะใช้เพื่อเก็บ Error Code เพียงอย่างเดียว ในขณะที่ความหมายของ Error Code ไม่จำเป็นต้องส่งออกไปเป็นข้อความ ส่วนความหมายจริง ๆ อาจจะทำเป็นเอกสารสำหรับนักพัฒนาเท่านั้น ตัวอย่างโค๊ดแบบแสดงข้อความ
  
  
  application/libraries/HttpMessage
  
  class HttpMessage{ const ERROR_AUTHENTICATION = "ไม่สามารถยืนยันตัวตนได้"; const ERROR_REGISTER_EXIST_EMAIL = "อีเมลนี้ถูกใช้งานแล้ว"; }

  1 2 3 4 5

  class HttpMessage{        const ERROR_AUTHENTICATION = "ไม่สามารถยืนยันตัวตนได้";      const ERROR_REGISTER_EXIST_EMAIL = "อีเมลนี้ถูกใช้งานแล้ว"; }




• 3. สร้างไฟล์ controllers/Service จะเป็นไฟล์ที่ประกอบด้วยเมธอดการทำงานหลักของ api ใช้ในการรับข้อมูล และคืนค่าข้อมูลกลับไปที่ mobile apps ในขั้นตอนของการพัฒนาจริง ๆ สามารถแยก controller ได้ ตัวอย่างเช่น อาจจะสร้าง controllers/User สำหรับจัดการกับสมาชิก และสร้าง controllers/Product สำหรับจัดการกับสินค้า สำหรับในบทความนี้จะสร้างเพียงเป็นตัวอย่างคือ controllers/Service แค่ไฟล์เดียว ตัวอย่างโค๊ดในไฟล์
  class Service extends Default_Controller { // สืบทอดคุณสมบัติจาก Default_Controller public $respond = array(); public function __construct() { parent::__construct(); // เริ่มทำงานฟังก์ชั่น authentication ที่สืบทอดมาผ่าน __construct $this->load->library('HttpMessage'); } public function login() { $this->respond['success'] = true; echo json_encode($this->respond); // คืนค่าข้อมูล json เป็น true กลับไปที่ mobile app ถ้าเข้าระบบสำเร็จ } public function register() { // รับข้อมูลบันทึกข้อมูลลงฐานข้อมูลและสร้างเงื่อนไขในการสมัครสมาชิก $this->respond['success'] = false; $this->respond['description'] = HttpMessage::ERROR_REGISTER_EXIST_EMAIL; echo json_encode($this->respond); } }

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21

  class Service extends Default_Controller { // สืบทอดคุณสมบัติจาก Default_Controller   public $respond = array(); public function __construct() { parent::__construct(); // เริ่มทำงานฟังก์ชั่น authentication ที่สืบทอดมาผ่าน __construct $this->load->library('HttpMessage'); } public function login() { $this->respond['success'] = true; echo json_encode($this->respond);  // คืนค่าข้อมูล json เป็น true กลับไปที่ mobile app ถ้าเข้าระบบสำเร็จ } public function register() { // รับข้อมูลบันทึกข้อมูลลงฐานข้อมูลและสร้างเงื่อนไขในการสมัครสมาชิก $this->respond['success'] = false; $this->respond['description'] = HttpMessage::ERROR_REGISTER_EXIST_EMAIL; echo json_encode($this->respond); } }

วิธีเรียกใช้งาน

ฝั่ง client หรือ mobile apps สามารถเข้าถึงแต่ละเมธอดได้ผ่านชื่อ controller และ Method นั้น ๆ เช่น

Web Service API จะทำงานก็ต่อเมื่อมี Request มาจาก Mobile Apps ทุกเมธอดใน api เมื่อได้รับ request ต้องทำการตรวจสอบข้อมูลในทุก ๆ กรณี เพื่อป้องกันข้อผิดพลาด เพื่อตรวจสอบอย่างแน่ใจแล้ว จึงจะ response ข้อมูลที่ถูกต้องกลับไปให้ mobile apps แสดงผลข้อมูลนั้น ๆ ในมือถือ