วิธีทดสอบกับ API จำลอง และสร้าง API ปลอมใช้เองเมื่อจำเป็น

เมื่อคุณกำลังสร้างส่วนหน้า (frontend), ดีบักไคลเอนต์, หรือเรียนรู้ไลบรารี HTTP ใหม่ คุณมักจะต้องใช้เอนด์พอยต์ที่ส่งคืนข้อมูล JSON ที่ดูเหมือนจริง โดยไม่ต้องตั้งค่าแบ็กเอนด์ Dummy API ให้สิ่งนั้นแก่คุณ: บริการสาธารณะ ฟรี และพร้อมใช้งานเสมอที่คุณสามารถเรียกใช้ได้ทันที คู่มือนี้จะรวบรวม Dummy API สาธารณะที่ดีที่สุด แสดงวิธีเรียกใช้งาน และอธิบายว่าเมื่อไหร่ที่คุณควรหยุดยืมข้อมูลของคนอื่นแล้วหันมาสร้าง Fake REST API ของคุณเอง หากคุณต้องการทำความเข้าใจเพิ่มเติมเกี่ยวกับภาพรวมของ Public API คู่มือ MDN ในการใช้ Fetch API จะเข้ากันได้ดีกับเนื้อหาทั้งหมดด้านล่าง

Dummy API คืออะไรกันแน่

Dummy API คือบริการโฮสต์ที่ส่งคืนข้อมูล JSON ที่ถูกกำหนดไว้ล่วงหน้าและดูเหมือนจริงสำหรับประเภททรัพยากรทั่วไป เช่น ผู้ใช้, โพสต์, สินค้า, ตะกร้าสินค้า, รายการสิ่งที่ต้องทำ คุณไม่จำเป็นต้องลงทะเบียน ไม่ต้องโฮสต์อะไร และไม่ต้องกังวลเรื่องการทำให้ข้อมูลจริงเสียหาย ส่วนใหญ่รองรับการดำเนินการ GET, POST, PUT, PATCH และ DELETE แต่การดำเนินการเขียนมักจะถูกจำลองขึ้นมา เซิร์ฟเวอร์จะส่งข้อมูลที่คุณส่งกลับมาพร้อมกับ ID และแกล้งทำเป็นว่าได้บันทึกแล้ว แต่ในความเป็นจริงแล้วไม่มีอะไรถูกบันทึกไว้ถาวร

นั่นคือคุณสมบัติสำคัญที่ต้องทำความเข้าใจก่อนที่คุณจะใช้งานมัน Dummy API เหมาะอย่างยิ่งสำหรับการสร้างต้นแบบที่เน้นการอ่าน และสำหรับการพิสูจน์ว่าโค้ดคำขอของคุณทำงานได้ มันไม่เหมาะสมทันทีที่คุณต้องการพฤติกรรมที่มีสถานะ (stateful), รูปแบบข้อมูลของคุณเอง, หรือเงื่อนไขข้อผิดพลาดที่กำหนดเอง

Dummy และ Fake API ฟรีที่ดีที่สุดสำหรับการทดสอบ

นี่คือ Public API ที่น่าสนใจทั้งหมดนี้ฟรีและไม่ต้องตั้งค่าแบ็กเอนด์ใดๆ จากฝั่งของคุณ

JSONPlaceholder

JSONPlaceholder คือแบบคลาสสิก มันให้บริการทรัพยากรที่เกี่ยวข้องกันหกประเภท: 100 โพสต์, 500 ความเห็น, 100 อัลบั้ม, 5,000 รูปภาพ, 200 รายการสิ่งที่ต้องทำ และ 10 ผู้ใช้ ความสัมพันธ์เป็นของจริง ดังนั้นโพสต์จึงมีคอมเมนต์และอัลบั้มมีรูปภาพ ทำให้เหมาะสำหรับการทดสอบการเรียกข้อมูลแบบซ้อนกัน

curl https://jsonplaceholder.typicode.com/posts/1

คุณจะได้รับออบเจกต์โพสต์เดียวกลับมา คำขอเขียนจะได้รับการยอมรับแต่ไม่ถูกบันทึก ดังนั้น POST /posts จะส่งคืน id: 101 ปลอมทุกครั้ง

DummyJSON

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

curl https://dummyjson.com/products/1

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

reqres.in

reqres.in มุ่งเน้นไปที่วงจรชีวิตของคำขอและการตอบกลับ: รายชื่อผู้ใช้, ผู้ใช้คนเดียว, การลงทะเบียน, การเข้าสู่ระบบ, การตอบกลับที่ล่าช้า มันถูกสร้างขึ้นเพื่อแสดงการแบ่งหน้าและการไหลของการยืนยันตัวตน สิ่งหนึ่งที่ควรทราบ: ระดับฟรีตอนนี้ต้องการส่วนหัว API key ส่ง x-api-key: reqres-free-v1 ไปพร้อมกับคำขอของคุณ มิฉะนั้นคุณจะได้รับข้อผิดพลาด 401

curl https://reqres.in/api/users/2 -H "x-api-key: reqres-free-v1"

เหมาะสำหรับกรณีใดบ้าง

หากคุณต้องการตัวเลือกที่หลากหลายกว่าสามตัวเลือกนี้ บทสรุปของPublic API สำหรับการทดสอบจะครอบคลุมตัวเลือกที่เฉพาะเจาะจงมากขึ้น และรายชื่อ Free Public API สำหรับนักพัฒนาก็มีประโยชน์เมื่อคุณต้องการข้อมูลตามหัวข้อ เช่น สภาพอากาศหรือสกุลเงิน

วิธีเรียกใช้ Dummy API ในโค้ดของคุณ

การเรียกใช้ก็เหมือนกับการเรียกใช้เอนด์พอยต์ HTTP ทั่วไป นี่คือตัวอย่าง fetch อย่างง่ายใน JavaScript ที่อ่านข้อมูลผู้ใช้แล้วส่งข้อมูลผู้ใช้ใหม่

// Read
const res = await fetch('https://dummyjson.com/users/1');
const user = await res.json();
console.log(user.firstName);

// Write (echoed back, not persisted)
const created = await fetch('https://dummyjson.com/users/add', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ firstName: 'Ada', lastName: 'Lovelace' }),
});
console.log(await created.json()); // returns an object with a fake id

ใน Python ด้วยไลบรารี requests ก็สั้นพอๆ กัน

import requests

r = requests.get("https://jsonplaceholder.typicode.com/todos/1")
print(r.json())

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

เมื่อ Public Dummy API ไม่เพียงพออีกต่อไป

Public Dummy API นั้นยอดเยี่ยมจนกระทั่งความต้องการของคุณเฉพาะเจาะจงขึ้น คุณจะเจอทางตันในสถานการณ์ทั่วไปบางอย่าง:

• รูปแบบข้อมูลของคุณไม่ตรงกัน แอปของคุณคาดหวังฟิลด์ subscription_tier และออบเจกต์ billing ที่ซ้อนกัน แต่ JSONPlaceholder ให้ posts และ albums คุณไม่สามารถดัดแปลงสคีมาของพวกเขาให้เข้ากับของคุณได้
• คุณต้องการสถานะ (state) ตะกร้าสินค้าจริงจะอัปเดตเมื่อคุณเพิ่มสินค้า Dummy API จะลืม POST ของคุณทันทีที่ส่งคืน
• คุณต้องการการควบคุมความล้มเหลว การทดสอบว่า UI ของคุณจัดการกับข้อผิดพลาด 429, การตอบกลับ 200 ที่ช้า, หรือเนื้อหาที่ผิดรูปแบบนั้นทำได้ยากเมื่อบริการสาธารณะทำงานได้ดีเสมอ
• คุณกำลังสร้างก่อนที่แบ็กเอนด์จะมีอยู่จริง ทีมส่วนหน้าและแบ็กเอนด์มักจะเริ่มทำงานพร้อมกัน คุณต้องการเอนด์พอยต์ที่ตรงตามข้อตกลงในปัจจุบัน ไม่ใช่เมื่อ API ถูกเผยแพร่

ณ จุดนั้น คุณไม่ต้องการ API ที่ยืมมา คุณต้องการ Fake API ของคุณเองที่ส่งคืนรูปแบบข้อมูลของคุณ ตามความต้องการ พร้อมการตอบกลับที่คุณควบคุมได้ นั่นคือ Mock API ที่สร้างขึ้นสำหรับการทดสอบ และเป็นจุดที่ Apidog เข้ามามีบทบาท

วิธีสร้าง Fake API ของคุณเองด้วย Apidog

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

นี่คือขั้นตอนการทำงานแบบสั้นๆ

1. สร้างหรือนำเข้าเอนด์พอยต์ กำหนด API ใหม่ใน Apidog หรือนำเข้าไฟล์ OpenAPI หรือ Swagger ที่มีอยู่ Apidog จะอ่านสคีมาโดยตรง
2. ให้ smart mock กรอกข้อมูล สำหรับฟิลด์ชื่อ email, Apidog จะส่งคืนอีเมล สำหรับ createdAt, จะส่งคืนการประทับเวลา สำหรับ price, จะส่งคืนตัวเลข คุณสามารถปรับแต่งกฎเหล่านี้สำหรับแต่ละฟิลด์ได้ เพื่อให้ฟิลด์ country ส่งคืนชื่อประเทศจริงแทนสตริงแบบสุ่ม
3. เรียกใช้ local mock URL Apidog จะเปิดใช้งานเซิร์ฟเวอร์ mock และให้ URL สำหรับแต่ละเอนด์พอยต์แก่คุณ เรียกใช้จากส่วนหน้า, การทดสอบของคุณ, หรือ curl ได้เหมือนกับ Public Dummy API ทุกประการ เพียงแต่การตอบกลับจะตรงตามข้อตกลงของคุณ
4. เพิ่มการตอบกลับแบบมีเงื่อนไขและข้อผิดพลาด กำหนดค่า mock ให้ส่งคืนข้อผิดพลาด 500, 404, หรือการตอบกลับที่ล่าช้าตามคำขอ ตอนนี้คุณสามารถทดสอบเส้นทางที่ไม่สมบูรณ์ซึ่งบริการสาธารณะไม่เคยทำให้คุณสามารถทำซ้ำได้

เนื่องจาก mock ถูกสร้างขึ้นจากสเปคของคุณ จึงยังคงซิงค์กันเมื่อการออกแบบของคุณพัฒนาขึ้น เปลี่ยนฟิลด์หนึ่ง และ mock ก็จะสะท้อนการเปลี่ยนแปลงนั้น หากคุณต้องการมุมมองที่กว้างขึ้นของการสร้าง mocks โดยตรงจากสเปค คำแนะนำการสร้างข้อมูล mock จาก OpenAPI Schemas จะเจาะลึกในส่วนของ Faker มากขึ้น

Public Dummy API เทียบกับ Apidog Mock ของคุณเอง

ไม่มีฝ่ายใดดีกว่าอย่างเคร่งครัด Public Dummy API จะได้เปรียบเมื่อคุณเพียงแค่ต้องการข้อมูล JSON ในเวลาห้าวินาที Apidog Mock ของคุณเองจะได้รับชัยชนะเมื่อความถูกต้องตามข้อตกลงจริงของคุณมีความสำคัญ ทีมส่วนใหญ่ใช้ทั้งสองแบบ: แบบสาธารณะสำหรับการทดลองที่ใช้แล้วทิ้ง และ mock สำหรับโปรเจกต์สำหรับทุกสิ่งที่จะส่งมอบ

คำถามที่พบบ่อย

Dummy API เหมือนกับ Mock API หรือไม่?

ทั้งสองสิ่งทับซ้อนกันแต่ไม่เหมือนกันทุกประการ Dummy API มักจะหมายถึงบริการสาธารณะที่ใช้ร่วมกันซึ่งมีข้อมูลตัวอย่างที่ตายตัว เช่น JSONPlaceholder Mock API คือสิ่งที่คุณกำหนดและควบคุมเอง โดยส่งคืนรูปแบบและพฤติกรรมของคุณเอง Dummy API เป็นรูปแบบหนึ่งของ mock ที่มีคนอื่นโฮสต์ไว้แล้ว หากคุณต้องการคำอธิบายความแตกต่างอย่างละเอียด โปรดดูคำอธิบายเกี่ยวกับMock API คืออะไร

Fake API ฟรี ปลอดภัยที่จะใช้กับข้อมูลจริงหรือไม่?

ไม่ ห้ามส่งข้อมูลผู้ใช้จริง, ความลับ, หรือโทเค็นไปยัง Public Dummy API โดยเด็ดขาด ถือว่าทุกสิ่งที่คุณ POST นั้นถูกบันทึกและมองเห็นได้ ใช้เฉพาะกับค่าทดสอบที่ใช้แล้วทิ้ง เมื่อคุณต้องการความเป็นส่วนตัวหรือการคงอยู่ของข้อมูล ให้โฮสต์ mock ของคุณเองแทน

Dummy API บันทึกข้อมูลที่ฉันส่งไปหรือไม่?

แทบจะไม่เคยเลย JSONPlaceholder, DummyJSON และ reqres.in ล้วนยอมรับคำขอเขียนและส่งผลลัพธ์กลับมาพร้อม ID ที่สร้างขึ้น แต่ไม่มีอะไรถูกบันทึกไว้ถาวร รีเฟรชหน้าเว็บแล้วข้อมูลที่คุณ 'สร้าง' ไว้ก็จะหายไป หากคุณต้องการสถานะที่คงอยู่ คุณต้องใช้ stateful mock หรือแบ็กเอนด์จริง

ฉันสามารถสร้าง Fake API โดยไม่ต้องเขียนโค้ดได้หรือไม่?

ได้ ด้วย Apidog คุณสามารถกำหนดรูปแบบเอนด์พอยต์และให้ smart mocking สร้างข้อมูล โดยไม่ต้องใช้โค้ดเซิร์ฟเวอร์ คุณยังสามารถนำเข้าไฟล์ OpenAPI และได้เอนด์พอยต์ mock ที่ใช้งานได้ภายในไม่กี่นาที

สรุป

Public Dummy API เช่น JSONPlaceholder, DummyJSON และ reqres.in เป็นวิธีที่เร็วที่สุดในการรับข้อมูล JSON ที่สมจริงสำหรับการสร้างต้นแบบและการเรียนรู้ ไม่เสียค่าใช้จ่ายและไม่ต้องตั้งค่าใดๆ เมื่อคุณต้องการรูปแบบข้อมูลของคุณเอง, สถานะจริง, หรือการตอบกลับข้อผิดพลาดที่ควบคุมได้ ให้สร้าง Fake API ที่คุณเป็นเจ้าของเอง

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