Apidog CLI เป็นจุดเริ่มต้นคำสั่งแบบบรรทัดสำหรับการรันการทดสอบ API จากเทอร์มินัล, CI pipeline, เวิร์กโฟลว์อัตโนมัติ หรือระบบภายนอกมาอย่างยาวนาน
apidog run --project <projectId> --test-scenario <scenarioId> --environment <environmentId>รากฐานนั้นยังคงสำคัญ ทีมงานยังคงต้องการวิธีที่เชื่อถือได้ในการรันการทดสอบ API, สร้างรายงาน และรักษาคุณภาพภายใน CI แต่การพัฒนา API กำลังเปลี่ยนแปลงไป เอไอเอเจนต์ (AI Agents) กำลังเข้ามามีส่วนร่วมในการออกแบบ API, การสร้างการทดสอบ, การดีบัก, การโยกย้าย และการบำรุงรักษา
สำหรับเวิร์กโฟลว์เหล่านั้น CLI ไม่ใช่แค่ขั้นตอนสุดท้ายที่รันการทดสอบที่มีอยู่เท่านั้น แต่ยังต้องให้เอเจนต์มีวิธีที่เสถียรในการอ่านสินทรัพย์ API, สร้างหรืออัปเดตสินทรัพย์การทดสอบ, ตรวจสอบการเปลี่ยนแปลงที่มีโครงสร้าง, เขียนกลับ และตรวจสอบผลลัพธ์
Apidog CLI ที่ได้รับการอัปเกรดนี้ยังคงรักษาพื้นฐานการรันการทดสอบเดิมไว้ และขยายเป็นเลเยอร์เวิร์กโฟลว์สำหรับนักพัฒนา, สคริปต์ และเอไอเอเจนต์ บทความนี้จะอธิบายว่าทำไม CLI ถึงมีความสำคัญมากขึ้นในยุคเอไอเอเจนต์, อะไรที่เปลี่ยนแปลงไปใน Apidog CLI และวิธีที่ทีมงานสามารถเริ่มใช้งานสำหรับการทำงานอัตโนมัติในการทดสอบ API
ทำไม CLI ถึงมีความสำคัญมากขึ้นในยุค AI Agent
ส่วนต่อประสานกราฟิกถูกออกแบบมาสำหรับคน ซึ่งเป็นภาพ, มีความยืดหยุ่น และมีประโยชน์สำหรับการสำรวจ อย่างไรก็ตาม AI Agents ทำงานได้ดีที่สุดกับคำสั่งที่มีโครงสร้าง, อินพุตที่คาดเดาได้, เอาต์พุตที่คาดเดาได้ และขั้นตอนการตรวจสอบที่ชัดเจน
นั่นคือจุดที่ CLI กลายเป็นสิ่งสำคัญ CLI มอบส่วนต่อประสานที่ทำซ้ำได้ให้กับเอเจนต์และสคริปต์สำหรับทรัพยากรเดียวกันกับที่นักพัฒนาจัดการใน Apidog: APIs, สภาพแวดล้อม, ตัวแปร, กรณีทดสอบ, สถานการณ์ทดสอบ, ชุดทดสอบ, รายงาน, การนำเข้า/ส่งออกข้อมูล และอื่น ๆ
ในทางปฏิบัติ สิ่งนี้หมายความว่า Apidog สามารถให้บริการทั้งผู้ใช้ที่เป็นมนุษย์และเวิร์กโฟลว์อัตโนมัติ ผู้คนยังคงออกแบบ, ดีบัก, ตรวจสอบ และทำงานร่วมกันในส่วนต่อประสานผลิตภัณฑ์ เอเจนต์และการทำงานอัตโนมัติสามารถใช้ CLI เพื่อดำเนินการควบคุมรอบสินทรัพย์เหล่านั้น
จาก apidog run สู่เวิร์กโฟลว์ API และการทดสอบเต็มรูปแบบ
ประสบการณ์ CLI ก่อนหน้านี้มุ่งเน้นไปที่การดำเนินการทดสอบเป็นหลัก ทำให้ apidog run มีประโยชน์ในฐานะเกตเวย์คุณภาพ CI แต่ก็หมายความว่า CLI มักจะปรากฏอยู่ใกล้จุดสิ้นสุดของเวิร์กโฟลว์ CLI ที่ได้รับการอัปเกรดจะขยายการครอบคลุมไปยังทรัพยากรหลักของ Apidog มากขึ้น ดังนั้นการทำงานอัตโนมัติจึงสามารถเข้าร่วมได้เร็วขึ้น: การอ่านบริบทของโปรเจกต์, การเตรียมสินทรัพย์ทดสอบ, การตรวจสอบการเปลี่ยนแปลงที่มีโครงสร้าง และจากนั้นจึงดำเนินการตรวจสอบ
ด้วย CLI ที่ได้รับการอัปเกรด ผู้ใช้และเอเจนต์สามารถทำงานกับทรัพยากรต่างๆ เช่น:
- โปรเจกต์และเมตาดาต้าของโปรเจกต์
- APIs และคำจำกัดความ API
- สภาพแวดล้อมและตัวแปร
- กรณีทดสอบ
- สถานการณ์ทดสอบ
- ชุดทดสอบ
- รายงาน
- เวิร์กโฟลว์การนำเข้าและส่งออก
- บัญชี, สาขา, ตัวรัน และทรัพยากรโปรเจกต์ที่เกี่ยวข้อง
สิ่งนี้เปลี่ยนบทบาทของ Apidog CLI ไม่ใช่แค่เพียงวิธีหนึ่งในการดำเนินการทดสอบหลังจากทุกสิ่งเสร็จสิ้นแล้วเท่านั้น ตอนนี้สามารถเข้าร่วมในวงจรการพัฒนาได้เร็วยิ่งขึ้น โดยที่ Agent จำเป็นต้องเข้าใจโปรเจกต์, สร้างหรืออัปเดตสินทรัพย์การทดสอบ, ตรวจสอบการเปลี่ยนแปลง และจากนั้นก็ทำการตรวจสอบ
วงจรที่ปลอดภัยยิ่งขึ้นสำหรับการทดสอบที่ขับเคลื่อนด้วย Agent
เมื่อ AI Agent ช่วยในการพัฒนาหรือทดสอบ API ส่วนที่เสี่ยงไม่ใช่แค่การสร้างเนื้อหาเท่านั้น ส่วนที่เสี่ยงคือการเขียนเนื้อหาที่สร้างขึ้นลงในโปรเจกต์จริงโดยไม่มีโครงสร้างหรือการตรวจสอบที่เพียงพอ
CLI ที่ได้รับการอัปเกรดทำให้เกิดวงจรที่ปลอดภัยยิ่งขึ้น:
วงจรนี้สำคัญเพราะทรัพยากร Apidog จำนวนมากมีโครงสร้าง กรณีทดสอบและสถานการณ์ทดสอบสามารถรวมข้อมูลคำขอ, การยืนยัน, การดึงตัวแปร, พรีโปรเซสเซอร์, โพสต์โปรเซสเซอร์, ลำดับขั้นตอน, การอ้างอิงสภาพแวดล้อม และรายละเอียดอื่นๆ หาก Agent คาดเดาโครงสร้าง ความผิดพลาดเล็กน้อยอาจทำให้การเขียนล้มเหลว, การแสดงผลใน UI ไม่สมบูรณ์ หรือการทดสอบไม่เป็นไปตามที่คาดไว้
นั่นคือเหตุผลที่ cli-schema เป็นส่วนสำคัญของการอัปเกรด ก่อนที่จะเขียนไฟล์ JSON ที่ซับซ้อนลงใน Apidog Agent สามารถขอให้ CLI ตรวจสอบว่าฟิลด์และโครงสร้างตรงกับสคีมาที่คาดไว้หรือไม่
apidog cli-schema validate test-case-create --file ./test-case-create.json
apidog cli-schema validate test-scenario-update --file ./scenario-update.jsonสรุป: ให้ Agent สร้าง แต่ให้ CLI ตรวจสอบก่อนที่จะมีการเขียน
CLI ยังสามารถให้คำแนะนำที่เน้น Agent ในผลลัพธ์ของคำสั่ง หลังจากสร้างหรืออัปเดตทรัพยากรแล้ว ขั้นตอนต่อไปมักจะไม่ใช่ "หยุด" Agent ที่น่าเชื่อถือมากขึ้นควรอ่านทรัพยากรที่บันทึกไว้กลับมา, ยืนยันโครงสร้าง และรันการทดสอบเมื่อเหมาะสม คำแนะนำเหล่านี้ช่วยให้ Agent ดำเนินการผ่านเวิร์กโฟลว์โดยมีจุดบอดน้อยลง
ทักษะช่วยให้ Agents มีวิจารณญาณในการปฏิบัติงาน
คำสั่ง CLI ให้พลังการดำเนินการแก่ Agent ทักษะช่วยให้ Agent มีวิจารณญาณในการปฏิบัติงาน
SKILL ไม่ใช่แค่การอ้างอิงคำสั่งเท่านั้น แต่เป็นเหมือนคู่มือการปฏิบัติงานที่เขียนขึ้นสำหรับ AI Agents: เมื่อใดควรใช้คำสั่ง, คำสั่งใดควรมาก่อน, ฟิลด์ใดที่ไม่ควรคาดเดา, เมื่อใดควรตรวจสอบ, เมื่อใดควรอ่านกลับ และเมื่อใดควรเรียกใช้การทดสอบ
ตัวอย่างเช่น Agent ที่น่าเชื่อถือไม่ควรเขียนสถานการณ์ทดสอบขนาดใหญ่ด้วยมือตั้งแต่ต้นเสมอไป รูปแบบที่ปลอดภัยกว่ามักจะเป็น:
- สร้างสถานการณ์พื้นฐาน
- นำเข้าขั้นตอนจาก APIs หรือกรณีทดสอบที่มีอยู่
- อ่านโครงสร้างสถานการณ์ฉบับเต็มกลับมา
- อัปเดตการยืนยัน, การดึงตัวแปร หรือโปรเซสเซอร์ในขั้นตอนย่อยๆ
- ตรวจสอบและรันสถานการณ์
ทักษะทำให้รูปแบบเหล่านี้ชัดเจน ช่วยให้ Agent หลีกเลี่ยงข้อผิดพลาดทั่วไป เช่น การใช้ชื่อฟิลด์ผิด, การเลือกค่า enum ผิด, การข้ามการตรวจสอบสคีมา หรือการสมมติว่าการเขียนสำเร็จหมายความว่าทรัพยากรสุดท้ายถูกต้องแล้ว
Apidog มี 8 ทักษะเสริมที่จะช่วยให้ Agent เข้าใจคำสั่ง CLI, โครงสร้างทรัพยากร และเวิร์กโฟลว์ของงาน เมื่อรวมกันแล้ว CLI และทักษะจะทำให้ Apidog มีประโยชน์มากขึ้นสำหรับการพัฒนาและทดสอบ API ที่ขับเคลื่อนด้วย AI
การเปลี่ยนแปลงโปรเจกต์ที่ปลอดภัยยิ่งขึ้นด้วย AI Branches
เมื่อ Agent แก้ไขทรัพยากรโปรเจกต์ ความปลอดภัยและการตรวจสอบได้เป็นสิ่งสำคัญ ด้วยเหตุผลนี้ CLI ที่ได้รับการอัปเกรดจึงสามารถใช้ร่วมกับ AI Branches ได้
Agent สามารถทำการเปลี่ยนแปลงในสาขาที่แยกออกมาก่อน ทีมสามารถตรวจสอบความแตกต่าง, ยืนยันผลลัพธ์ และจากนั้นรวมเข้ากับสาขาเป้าหมาย ซึ่งช่วยป้องกันการเปลี่ยนแปลงอัตโนมัติจากการส่งผลกระทบโดยตรงต่อสาขาหลักหรือสาขาที่ใช้ร่วมกัน
สิ่งนี้ปลดล็อกอะไรในเวิร์กโฟลว์จริง
คุณค่าของ CLI ที่ได้รับการอัปเกรดนั้นเห็นได้ชัดเจนที่สุดในเวิร์กโฟลว์ที่จับต้องได้
สร้างการทดสอบจากคำจำกัดความ API
Agent สามารถอ่านคำจำกัดความ API จากโปรเจกต์ สร้างกรณีทดสอบ ตรวจสอบ JSON ที่สร้างขึ้นด้วย cli-schema เขียนกรณีทดสอบลงใน Apidog อ่านกลับมา และเรียกใช้การตรวจสอบ สิ่งนี้จะเปลี่ยนการสร้างการทดสอบจากคำแนะนำครั้งเดียวให้เป็นเวิร์กโฟลว์ที่ควบคุมได้
ดูแลรักษาสถานการณ์ทดสอบที่ซับซ้อน
สำหรับสถานการณ์แบบหลายขั้นตอน Agent สามารถนำเข้าขั้นตอนจาก APIs หรือกรณีทดสอบที่มีอยู่ก่อน จากนั้นจึงอัปเดตการยืนยัน ตัวแปร หรือโปรเซสเซอร์หลังจากอ่านโครงสร้างที่สมบูรณ์กลับมา ซึ่งช่วยลดความเสี่ยงในการสร้างสถานการณ์ขนาดใหญ่ผิดพลาดในการลองครั้งเดียว
apidog test-scenario import-steps <scenarioId> --project <projectId> --source endpoint --ids <endpointIds> --sync manual
apidog test-scenario get <scenarioId> --project <projectId> --with-case-detailย้ายและทำซ้ำสินทรัพย์ของโปรเจกต์
CLI ที่ได้รับการอัปเกรดยังปรับปรุงเวิร์กโฟลว์การนำเข้าและส่งออกสำหรับข้อมูล Apidog ดั้งเดิม สิ่งนี้มีประโยชน์สำหรับการโยกย้ายโปรเจกต์, การทำซ้ำสภาพแวดล้อมของลูกค้า, การคัดลอกการตั้งค่าการทดสอบ หรือการย้าย APIs, สคีมา, กรณีทดสอบ และสถานการณ์ข้ามโปรเจกต์
apidog export --project <projectId> --format apidog --output ./project.apidog.json
apidog import --project <projectId> --format apidog --file ./project.apidog.jsonรักษาเกตเวย์คุณภาพ CI
ความสามารถใหม่ที่พร้อมสำหรับ Agent ไม่ได้เข้ามาแทนที่ CI แต่เป็นการเสริมกัน ทีมงานยังคงสามารถใช้ apidog run เป็นจุดเริ่มต้นหลักสำหรับการดำเนินการทดสอบอัตโนมัติและรายงานได้
apidog run --project <projectId> --test-scenario <scenarioId> --environment <environmentId> -r "cli,html,junit" --out-dir ./apidog-reportsเริ่มต้นใช้งาน
หากคุณติดตั้ง Apidog CLI ไว้แล้ว ให้ตรวจสอบเวอร์ชันปัจจุบันของคุณก่อน:
apidog -vหาก Apidog CLI version ของคุณเก่ากว่า 2.2.5 ให้อัปเดต CLI ก่อนที่จะใช้ความสามารถใหม่ เวอร์ชันนี้อ้างอิงถึง Apidog CLI ไม่ใช่แอป Apidog
คุณสามารถขอให้ AI Agent ที่คุณใช้ติดตั้งทั้ง Apidog CLI และ Skills เสริมโดยคัดลอกพรอมต์นี้:
Read the instructions and help me install Apidog CLI:
https://apidog.com/apidog-cli-installation-guide.mdหากคุณต้องการติดตั้งหรืออัปเดตด้วยตนเอง ให้รัน:
npm install -g apidog-cli@latestสำหรับการอ้างอิงคำสั่งแบบเต็ม โปรดดูที่ Apidog CLI Options
ลองงาน Agent แรกของคุณ
หลังจากติดตั้ง CLI และ Skills แล้ว วิธีที่ง่ายที่สุดในการเริ่มต้นคือการมอบงาน API ขนาดเล็กที่มีความเสี่ยงต่ำให้กับ Agent ของคุณ ตัวอย่างเช่น ขอให้สร้าง endpoint ตรวจสอบสถานะการทำงาน (health check) อย่างง่ายในโปรเจกต์ Apidog จากนั้นอ่านกลับมาเพื่อยืนยันผลลัพธ์
คัดลอกพรอมต์นี้ลงใน AI Agent ของคุณ:
Use Apidog CLI to help me create my first API endpoint in Apidog. First, check my Apidog CLI setup and list the projects I can access. Ask me which project to use. After I confirm, create a simple GET /health endpoint named Health Check with a 200 response example. Validate any structured input before writing, then read the endpoint back and summarize what was created.สิ่งนี้ช่วยให้ผู้ใช้ใหม่มีจุดเริ่มต้นที่เป็นรูปธรรม: Agent ตรวจสอบการตั้งค่า, สอบถามก่อนที่จะเขียนลงในโปรเจกต์, สร้างคำจำกัดความ API ขนาดเล็ก และยืนยันผลลัพธ์ที่บันทึกไว้
ขั้นตอนต่อไป:
- ดาวน์โหลด Apidog เพื่อออกแบบ, ดีบัก, ทดสอบ และจัดทำเอกสาร API ในพื้นที่ทำงานเดียว
- เรียนรู้เพิ่มเติมเกี่ยวกับ Apidog CLI สำหรับการทดสอบ API ผ่านบรรทัดคำสั่ง, การทำงานอัตโนมัติของ CI และเวิร์กโฟลว์ของ AI Agent
คำถามที่พบบ่อย
Apidog CLI คืออะไร?
Apidog CLI เป็นเครื่องมือบรรทัดคำสั่งสำหรับรันการทดสอบ API, ทำงานกับทรัพยากรโปรเจกต์ Apidog และเชื่อมโยงสินทรัพย์ API และการทดสอบของ Apidog เข้ากับเวิร์กโฟลว์อัตโนมัติ
Apidog CLI สามารถรันการทดสอบ API ใน CI ได้หรือไม่?
ได้ ทีมงานสามารถใช้ apidog run ใน CI pipelines เพื่อรันการทดสอบ API, สร้างรายงาน และรักษาคุณภาพอัตโนมัติในเวิร์กโฟลว์การทดสอบของพวกเขา
Apidog CLI ช่วย AI Agents ได้อย่างไร?
Apidog CLI ช่วยให้ AI Agents มีวิธีที่มีโครงสร้างในการอ่านข้อมูล API, สร้างหรืออัปเดตสินทรัพย์การทดสอบ, ตรวจสอบการเปลี่ยนแปลง, เขียนลงใน Apidog, อ่านผลลัพธ์กลับมา และรันการทดสอบเพื่อตรวจสอบ
cli-schema ใน Apidog CLI คืออะไร?
cli-schema ช่วยตรวจสอบไฟล์ JSON ที่ซับซ้อนก่อนที่จะถูกเขียนลงใน Apidog ซึ่งช่วยลดการเขียนที่ล้มเหลว, ฟิลด์ที่ไม่ถูกต้อง และวงจรการลองซ้ำที่ไม่จำเป็นเมื่อ Agents สร้างหรืออัปเดตกรณีทดสอบและสถานการณ์ทดสอบ
ฉันจะติดตั้ง Apidog CLI ได้อย่างไร?
คุณสามารถขอให้ AI Agent ทำตามคู่มือการติดตั้ง Apidog CLI และติดตั้งทั้ง CLI และ Skills เสริม หรือติดตั้งด้วยตนเองโดยใช้ npm install -g apidog-cli@latest