พื้นฐานการเชื่อมต่อด้วย API
ในปัจจุบันมีผลิตภัณฑ์และบริการจำนวนมากที่มีการใช้งานอุปกรณ์ IoT เป็นองค์ประกอบ และในการเชื่อมต่อระหว่างอุปกรณ์และระบบแอพพลิเคชัน รูปแบบที่ได้รับความนิยมอย่างมากคือการใช้ API (Application Programming Interface) ที่จะทำให้อุปกรณ์ต่างๆ สามารถสื่อสารและแลกเปลี่ยนข้อมูลกันได้อย่างมีประสิทธิภาพ ตลอดจนสามารถเชื่อมต่อข้ามระบบได้ หากมีการทำ API ไว้ให้เรียกใช้โดย API คือชุดของคำสั่งและฟังก์ชันที่ให้บริการแก่โปรแกรมต่างๆ เพื่อให้สามารถสื่อสารกันได้ โดยจะทำหน้าที่เป็นตัวกลางระหว่างผู้ใช้ (Client) และเซิร์ฟเวอร์ (Server) โดยใช้รูปแบบการทำงานแบบร้องขอ (Request) และตอบกลับ (Response)
ข้อดีของการใช้ API ในการเชื่อมต่อระหว่างอุปกรณ์และระบบมีหลายอย่าง เช่นการใช้ API สามารถเชื่อมได้หลายอุปกรณ์ มีความรวดเร็ว สามารถขยายได้หากในอนาคตมีความต้องการในการใช้งานมากขึ้นและสามารถจำกัดการใช้งานได้ มีความปลอดภัยสูง
ตัวอย่างการใช้งานของ API เช่นการเชื่อมต่ออุปกรณ์ IoT กับระบบแอพพลิเคชันบนคลาวด์ ทำให้สามารถส่งข้อมูลที่อ่านได้จากเซนเซอร์ไปประมวลผลและแสดงผลบนแอพพลิเคชันได้ การควบคุมอุปกรณ์ไฟฟ้าผ่านทางโทรศัพท์ การเก็บข้อมูลสุขภาพของคนไข้และแสดงให้บุคลากรทางการแพทย์เพื่อประกอบการรักษา การส่งข้อมูลที่อ่านค่าระดับน้ำมาแสดงผลบนหน้า Dashboard เป็นต้น
การเรียก API เป็นกระบวนการที่โปรแกรมทำการร้องขอ (Request) ข้อมูลจาก API และ API ทำการตอบสนอง (Responses) ข้อมูลกลับมาตามคำร้องขอโดยข้อมูลที่ส่งกลับมาจะอยู่ในรูปแบบ JSON หรือ XML โดนกระทำในรูปแบบของ HTTP (Hypertext Transfer Protocol) เป็นโปรโตคอลที่ใช้สำหรับการส่งข้อมูลระหว่างผู้ใช้ (Client) และเซิร์ฟเวอร์ (Server) โดยมีการใช้วิธีการ (methods) ต่างๆ ได้แก่
BDH IoT Data Service API Development
ขั้นตอนการ สร้าง API ด้วย Express.js
1. เปิด vscode และสร้าง folder ใช้ชื่อว่า api-server-workshop
2. เปิด folder ด้วยโปรแกรม vsCode และทำการสร้าง nodejs project ผ่าน termial โดยใช้คำสั่ง
Copy npm install express swagger-jsdoc swagger-ui-express --save
Copy const express = require('express');
const swaggerJsDoc = require('swagger - jsdoc');
const swaggerUi = require('swagger - ui - express');
const app = express();
app .use(express.json());
// การตั้งค่า Swagger
const swaggerOptions = {
swaggerDefinition : {
openapi : ' 3.0 . 0 ' ,
info : {
title : 'IoT Device API' ,
version : ' 1.0 . 0 ' ,
description : 'API สำหรับจัดการข้อมูล IoT Device' ,
} ,
servers : [
{
url : 'http :// localhost : 3000 ' ,
} ,
] ,
} ,
apis : ['. / app .js'] ,
};
const swaggerDocs = swaggerJsDoc(swaggerOptions);
app .use(' / docs', swaggerUi.serve, swaggerUi.setup(swaggerDocs));
// ข้อมูลตัวอย่างสำหรับ IoT Device
let devices = [
{ id : 1 , name : 'Temperature Sensor' , type : 'sensor' , status : 'active' },
{ id : 2 , name : 'Humidity Sensor' , type : 'sensor' , status : 'inactive' },
];
/**
* @swagger
* / devices :
* get:
* summary : รับข้อมูล IoT Devices ทั้งหมด
* responses :
* 200 :
* description : สำเร็จ
* content :
* application / json :
* schema :
* type : array
* items :
* type : object
* properties :
* id:
* type : integer
* name :
* type : string
* type :
* type : string
* status :
* type : string
*/
app . get (' / devices', (req, res) => {
res.json(devices);
});
/**
* @swagger
* / devices / { id } :
* get:
* summary : รับข้อมูล IoT Device โดยใช้ ID
* parameters :
* - in: path
* name : id
* required : true
* schema :
* type : integer
* description : ID ของ IoT Device
* responses :
* 200 :
* description : สำเร็จ
* content :
* application / json :
* schema :
* type : object
* properties :
* id:
* type : integer
* name :
* type : string
* type :
* type : string
* status :
* type : string
* 404 :
* description : ไม่พบอุปกรณ์
*/
app . get (' / devices /:id ', (req, res) => {
const device = devices.find((d) => d. id === parseInt(req.params. id ));
if (!device) return res.status( 404 ).send('ไม่พบอุปกรณ์');
res.json(device);
});
/**
* @swagger
* / devices :
* post :
* summary : เพิ่ม IoT Device ใหม่
* requestBody :
* required : true
* content :
* application / json :
* schema :
* type : object
* properties :
* name :
* type : string
* type :
* type : string
* status :
* type : string
* responses :
* 201 :
* description : สร้างอุปกรณ์ใหม่สำเร็จ
*/
app .post(' / devices', (req, res) => {
const newDevice = {
id : devices. length + 1 ,
name : req.body. name ,
type : req.body.type ,
status : req.body.status ,
};
devices.push(newDevice);
res.status( 201 ).json(newDevice);
});
/**
* @swagger
* / devices / { id } :
* put:
* summary : แก้ไขข้อมูล IoT Device โดยใช้ ID
* parameters :
* - in: path
* name : id
* required : true
* schema :
* type : integer
* description : ID ของ IoT Device
* requestBody :
* required : true
* content :
* application / json :
* schema :
* type : object
* properties :
* name :
* type : string
* type :
* type : string
* status :
* type : string
* responses :
* 200 :
* description : แก้ไขข้อมูลสำเร็จ
* 404 :
* description : ไม่พบอุปกรณ์
*/
app . put (' / devices /:id ', (req, res) => {
const device = devices.find((d) => d. id === parseInt(req.params. id ));
if (!device) return res.status( 404 ).send('ไม่พบอุปกรณ์');
device. name = req.body. name ;
device.type = req.body.type;
device.status = req.body.status;
res.json(device);
});
/**
* @swagger
* / devices / { id } :
* delete :
* summary : ลบ IoT Device โดยใช้ ID
* parameters :
* - in: path
* name : id
* required : true
* schema :
* type : integer
* description : ID ของ IoT Device
* responses :
* 200 :
* description : ลบอุปกรณ์สำเร็จ
* 404 :
* description : ไม่พบอุปกรณ์
*/
app .delete(' / devices /:id ', (req, res) => {
const deviceIndex = devices.findIndex((d) => d. id === parseInt(req.params. id ));
if (deviceIndex === -1 ) return res.status( 404 ).send('ไม่พบอุปกรณ์');
devices.splice(deviceIndex , 1 );
res.send('ลบอุปกรณ์สำเร็จ');
});
// เริ่มเซิร์ฟเวอร์
const PORT = process.env.PORT || 3000 ;
app .listen(PORT, () => console. log (`Server is running on port ${PORT}`)); 
