วิธีสร้างและทดสอบ CRUD REST API

ในยุคปัจจุบัน การจัดการข้อมูลอย่างมีประสิทธิภาพเป็นสิ่งสำคัญอย่างยิ่ง การใช้ CRUD ร่วมกับ REST API ช่วยให้การดำเนินการกับข้อมูลคล่องตัวและได้มาตรฐานในการพัฒนาเว็บสมัยใหม่ การดำเนินการ CRUD (สร้าง, อ่าน, อัปเดต, ลบ) ช่วยให้ข้อมูลโต้ตอบกับฐานข้อมูลได้

ในทางกลับกัน REST (Representational State Transfer) API มอบชุดหลักการที่ชี้นำการออกแบบแอปพลิเคชันเครือข่าย คุณสามารถสร้าง CRUD REST API ได้โดยทำตามขั้นตอนในบทความนี้ และเอกสาร, จำลอง, และทดสอบ API ของคุณด้วย Apidog

button

CRUD REST API คืออะไร?

CRUD API รองรับการดำเนินการพื้นฐานของการสร้าง, อ่าน, อัปเดต, และลบ ช่วยให้ผู้ใช้หรือแอปพลิเคชันโต้ตอบกับฐานข้อมูลหรือระบบจัดเก็บข้อมูลโดยการสร้าง, ดึงข้อมูล, อัปเดต, และลบระเบียน

ตัวอย่างเช่น CRUD API สำหรับการจัดการผู้ใช้อาจมีจุดสิ้นสุดเช่น:

POST /api/users: สร้างผู้ใช้ใหม่
GET /api/users/:id: ดึงรายละเอียดของผู้ใช้เฉพาะ
PUT /api/users/:id: อัปเดตรายละเอียดทั้งหมดของผู้ใช้เฉพาะ
PATCH /api/users/:id: อัปเดตรายละเอียดเฉพาะของผู้ใช้
DELETE /api/users/:id: ลบผู้ใช้เฉพาะ

วิธีการสร้าง CRUD REST API?

การสร้าง CRUD REST API เกี่ยวข้องกับหลายขั้นตอน เราจะสร้างโปรเจกต์ง่ายๆ โดยใช้ Express.js ทำตามขั้นตอนทั้งหมดอย่างระมัดระวังเพื่อสร้าง REST API ให้สำเร็จ

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

คุณต้องติดตั้ง Node.js บนเครื่องของคุณ คุณสามารถติดตั้งได้ ที่นี่
คุณต้องมีตัวแก้ไขโค้ด เช่น Visual Studio Code บนระบบของคุณ

ขั้นตอนที่ 1: เริ่มต้นโปรเจกต์ Node.js

เปิดเทอร์มินัล เช่น Command prompt หรือ Terminal และพิมพ์คำสั่งต่อไปนี้ mkdir จะสร้างไดเรกทอรีของโปรเจกต์ของคุณ และ npm init -y จะเริ่มต้นโปรเจกต์ของคุณ

mkdir crud-rest-api

cd crud-rest-api

npm init -y

ขั้นตอนที่ 2: ติดตั้งการพึ่งพา

ติดตั้งแพ็คเกจที่จำเป็นสำหรับการจัดการคำขอ HTTP และสำหรับการแยกวิเคราะห์คำขอ

npm install express body-parser

ขั้นตอนที่ 3: สร้างแอป Express.js

สร้างไฟล์ชื่อ app.js ในไดเรกทอรีโปรเจกต์ของคุณและเพิ่มโค้ดต่อไปนี้

const express = require('express');

const bodyParser = require('body-parser');

const app = express();

app.use(bodyParser.json());

// Your routes will go here

const PORT = 3000;

app.listen(PORT, () => {

console.log(`Server is running on port ${PORT}`);

});

โปรดทราบว่าเรายังไม่ได้เขียนเส้นทางของเรา เราจะทำเช่นนั้นในขั้นตอนถัดไป

ขั้นตอนที่ 4: ตั้งค่าการดำเนินการ CRUD ของคุณ

กำหนดเส้นทางของคุณสำหรับการจัดการการดำเนินการ CRUD ใส่โค้ดนี้ไว้ใน app.js ของคุณด้วย

// Sample data

let items = [

{ id: 1, name: 'Item 1' },

{ id: 2, name: 'Item 2' },

];

// Create

app.post('/items', (req, res) => {

const newItem = req.body;

items.push(newItem);

res.status(201).json(newItem);

});

// Read

app.get('/items', (req, res) => {

res.json(items);

});

// Update

app.put('/items/:id', (req, res) => {

const itemId = parseInt(req.params.id);

const updatedItem = req.body;

items = items.map(item => (item.id === itemId ? updatedItem : item));

res.json(updatedItem);

});

// Delete

app.delete('/items/:id', (req, res) => {

const itemId = parseInt(req.params.id);

items = items.filter(item => item.id !== itemId);

res.sendStatus(204);

});

ขั้นตอนที่ 5: รันแอปของคุณ

ตอนนี้คุณสามารถรันเซิร์ฟเวอร์ของคุณได้แล้ว

node app.js

หากแอปของคุณถูกสร้างขึ้นสำเร็จ คุณจะเห็นบางอย่างเช่นนี้ในเทอร์มินัลของคุณ

Apidog คืออะไร?

Apidog เป็นแพลตฟอร์ม API อเนกประสงค์ที่ช่วยลดความซับซ้อนในการทดสอบ API, การดีบัก, การออกแบบ, การจำลอง, และกระบวนการจัดทำเอกสาร ด้วยอินเทอร์เฟซที่เป็นมิตรต่อผู้ใช้และชุดเครื่องมือที่หลากหลาย Apidog ช่วยเพิ่มความร่วมมือภายในทีมที่ทำงานในโปรเจกต์ต่างๆ

มันปรับปรุงการทดสอบ API ทำให้สามารถประเมินผลได้อย่างละเอียดมากขึ้น และอำนวยความสะดวกในการสร้างสคีมา JSON/XML สำหรับผลการทดสอบและการตอบสนอง

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

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

button

วิธีการทดสอบ CRUD REST API ด้วย Apidog?

ตอนนี้คุณได้สร้างแอปพลิเคชันของคุณแล้ว คุณสามารถทดสอบ API ของคุณบน Apidog ได้ Apidog มีอินเทอร์เฟซแบบกราฟิกสำหรับการสร้างคำขอ การตั้งค่าข้อความและพารามิเตอร์ การบันทึกคำขอ และการเชื่อมต่อกับบริการ API ขั้นตอนในการทดสอบ API ของคุณด้วย Apidog มีดังนี้

button

1. สร้างโปรเจกต์ใหม่ใน Apidog คุณสามารถตั้งชื่อโปรเจกต์นี้ได้ตามที่คุณต้องการ

2. เมื่อสร้างโปรเจกต์ของคุณแล้ว ให้ไปที่ส่วน API และคลิกที่ New API

คลิกที่เครื่องหมาย + ถัดจากแถบค้นหาเพื่อเลือก API ชนิดที่คุณต้องการทดสอบ ในกรณีของเรา เราจะดูที่ New API

3. ตรวจสอบให้แน่ใจว่าได้ตั้งค่าสภาพแวดล้อมของคุณตามความต้องการของคุณ เราจะทำงานใน Development Environment สำหรับตัวอย่างของเรา

4. ป้อน API ของคุณและคลิกที่ “ส่ง” คุณจะสามารถดูการตอบสนองทั้งหมดในผลลัพธ์ของคุณ

ประโยชน์ของการใช้ Apidog กับ CRUD REST API

มีประโยชน์หลายประการที่ Apidog มอบให้เมื่อใช้ในการทดสอบ CRUD REST API

เอกสาร API:

Apidog มีเครื่องมือสำหรับการสร้างเอกสาร API ที่ครอบคลุมและโต้ตอบได้สำหรับ CRUD REST API ของคุณ นอกจากนี้ยังให้เอกสารที่ชัดเจนและมีโครงสร้างที่ดีสำหรับนักพัฒนาที่ต้องการทำความเข้าใจวิธีการใช้ API ของตนอย่างมีประสิทธิภาพ

การทดสอบและการดีบัก:

Apidog มีคุณสมบัติหลายอย่างสำหรับการทดสอบและการดีบักการดำเนินการ CRUD บน REST API ของคุณ สิ่งนี้มีประโยชน์อย่างยิ่งในระหว่างการพัฒนาและการทดสอบ ทำให้ผู้พัฒนาสามารถระบุและแก้ไขปัญหาได้อย่างมีประสิทธิภาพมากขึ้น

การสำรวจ API:

เครื่องมือเช่น Apidog มีอินเทอร์เฟซแบบโต้ตอบสำหรับการสำรวจและโต้ตอบกับจุดสิ้นสุด API ที่แตกต่างกัน สิ่งนี้มีประโยชน์สำหรับนักพัฒนาที่ต้องการทดลองกับคำขอต่างๆ และทำความเข้าใจการตอบสนองที่คาดหวัง

การสร้างโค้ด:

เครื่องมือ API บางอย่าง รวมถึง Apidog อาจมีความสามารถในการสร้างโค้ด สิ่งนี้สามารถช่วยเหลือนักพัฒนาได้โดยการสร้างโค้ดสนิปเป็ตในภาษาการเขียนโปรแกรมต่างๆ โดยอัตโนมัติตามเอกสาร API ทำให้การรวม API เข้ากับแอปพลิเคชันของพวกเขาง่ายขึ้น

การทำงานร่วมกันและการทำงานเป็นทีม:

Apidog อำนวยความสะดวกในการทำงานร่วมกันระหว่างสมาชิกในทีมโดยการจัดหาแพลตฟอร์มส่วนกลางสำหรับเอกสาร API การทดสอบ และการอภิปราย สิ่งนี้สามารถปรับปรุงการสื่อสารและการประสานงานระหว่างนักพัฒนาที่ทำงานใน