พื้นที่ทำงาน API ของคุณอยู่ใน GUI วันทำงานของคุณอยู่ในเทอร์มินัล การสลับบริบทไปมาระหว่างสองอย่างนี้ทำให้เสียเวลาและสมาธิ และในไพป์ไลน์ CI หรือเซสชัน AI agent, GUI ก็ไม่ใช่ทางเลือกด้วยซ้ำ Apidog CLI ปิดช่องว่างนี้: มันนำแพลตฟอร์ม Apidog ทั้งหมด, การทดสอบ, จุดเชื่อมต่อ (endpoints), สคีมา, สภาพแวดล้อม, การคาดการณ์ Mock และเอกสารทั้งหมด มายังพร้อมต์เชลล์ที่คุณเปิดอยู่แล้ว
คำจำกัดความที่ซื่อสัตย์ก่อนสิ่งอื่นใด Apidog CLI ไม่ใช่ curl อีกตัว หากคุณต้องการยิง GET ครั้งเดียวและดู JSON, curl และ HTTPie ก็ทำได้ดีอยู่แล้ว และบทสรุป Terminal และ TUI REST clients ก็ครอบคลุมด้านการโต้ตอบ Apidog CLI เป็นไคลเอนต์สำหรับพื้นที่ทำงาน API ของคุณเอง: มันรันสถานการณ์การทดสอบที่คุณสร้างขึ้น, อ่านและอัปเดตสัญญา API, และย้ายข้อมูลจำเพาะเข้าออกโปรเจกต์ ทั้งหมดนี้ทำได้จากคำสั่งที่สคริปต์หรือ agent สามารถเรียกใช้ได้
“สิ่งที่อยู่ในเทอร์มินัลของคุณ” หมายถึงอะไรในที่นี้
เครื่องมือ HTTP บนเทอร์มินัลจัดการคำขอครั้งละหนึ่งรายการ Apidog CLI ทำงานในระดับโปรเจกต์ พื้นที่คำสั่งของมันครอบคลุมมากกว่าสี่สิบกลุ่ม และจัดกลุ่มเป็นห้างาน:
| งาน | คำสั่ง |
|---|---|
| รันการทดสอบ | run, test-scenario, test-suite, test-case, test-data, test-report |
| จัดการสัญญา | endpoint, schema, folder, common-parameter, response-component, security-scheme |
| จัดส่งเอกสารและ Mock | doc, docs-site, shared-doc, mock |
| กำหนดค่าและเชื่อมต่อ | environment, variables, vault, database-connection, websocket, socketio |
| ทำงานเป็นทีม | branch, merge-request, runner, scheduled-task, audit-log, import, export |
ทุกคำสั่งรองรับ --help, ผลลัพธ์เป็น JSON ที่มีโครงสร้าง และการตอบกลับส่วนใหญ่รวมถึง agentHints.nextSteps ที่บอกคุณ (หรือ agent ของคุณ) ว่าจะรันอะไรต่อไป รายละเอียดสุดท้ายนี้ดูเล็กน้อย แต่มันเปลี่ยนความรู้สึกของเครื่องมือ: CLI จะนำทางเวิร์กโฟลว์แทนที่จะสันนิษฐานว่าคุณจำได้ทั้งหมด
ติดตั้งได้ในคำสั่งเดียว
CLI จัดส่งเป็นแพ็กเกจ npm (apidog-cli) และทำงานบน macOS, Linux และ Windows มันต้องการ Node.js เวอร์ชัน 16 หรือใหม่กว่า
npm install -g apidog-cli
apidog --version
จากนั้นลงชื่อเข้าใช้ด้วยโทเค็นการเข้าถึง API ดึงมาจากแอป Apidog: คลิกรูปประจำตัวของคุณ, เปิดการตั้งค่าบัญชี, และคัดลอกโทเค็นภายใต้ API Access Token
apidog login --with-token <YOUR_TOKEN>
โทเค็นจะไปอยู่ใน ~/.apidog/config.toml ดังนั้นเก็บให้ห่างจากที่เก็บและบันทึกของคุณ ใน CI ให้ส่งต่อโทเค็นต่อการรันด้วย --access-token จากความลับแทน แฟล็กส่วนกลางสี่ตัวครอบคลุมบริบทส่วนใหญ่: --project เลือกโปรเจกต์, --branch เลือกสาขา, --access-token เขียนทับการเข้าสู่ระบบที่บันทึกไว้ และ --api-base-url ชี้ CLI ไปยังการติดตั้ง Apidog แบบโฮสต์เอง คู่มือการรับรองความถูกต้องของ Apidog CLI จะอธิบายโทเค็นสำหรับ CI โดยละเอียด
รันการทดสอบที่คุณสร้างขึ้นด้วยภาพ
นี่คือเวิร์กโฟลว์ที่ CLI สร้างขึ้นรอบๆ คุณสร้างสถานการณ์การทดสอบในตัวแก้ไขภาพของ Apidog: คำขอที่เชื่อมโยงกัน, ตัวแปรที่ดึงมาจากคำตอบหนึ่งและใส่เข้าไปในคำตอบถัดไป, การยืนยันสถานะและเนื้อหา จากนั้นคุณก็รันมันได้ทุกที่ที่มีเชลล์
# คัดลอกคำสั่งนี้ รวมถึง ID จากแท็บ CI/CD ของสถานการณ์
apidog run -t <scenario_id> -e <env_id> -r cli
คำสั่งจะออกด้วยค่า 0 เมื่อการยืนยันทุกอย่างผ่าน และไม่เป็นศูนย์เมื่อมีสิ่งใดล้มเหลว ดังนั้นไพป์ไลน์จึงสามารถควบคุมได้โดยไม่ต้องมีการเชื่อมต่อเพิ่มเติม สลับ -e เพื่อชี้สถานการณ์เดียวกันไปยังสภาพแวดล้อม dev, staging หรือ production ป้อนไฟล์ CSV หรือ JSON ให้มัน แล้วมันจะวนซ้ำสถานการณ์ไปในแต่ละแถว ซึ่งเป็นวิธีที่ การทดสอบที่ขับเคลื่อนด้วยข้อมูล ทำงานโดยไม่ซ้ำขั้นตอน หากคุณกำลังเริ่มต้นจากศูนย์ คำแนะนำทีละขั้นตอน REST API จะพาคุณตั้งแต่การติดตั้งไปจนถึงการรันครั้งแรกที่ประสบความสำเร็จ
รายงานออกมาในสี่รูปแบบ: cli พิมพ์ผลลัพธ์ทีละขั้นตอนไปยังเทอร์มินัล ในขณะที่ html, json และ junit จะอยู่ใน apidog-reports/ สำหรับแดชบอร์ดและอาร์ติแฟกต์ CI สามารถรวมกันได้อย่างอิสระ เช่น -r cli,junit คู่มือรายงานการทดสอบ แสดงให้เห็นว่าแต่ละรูปแบบมีลักษณะอย่างไร
สำหรับการรันที่ไม่ควรขึ้นอยู่กับแล็ปท็อปของคุณ คำสั่ง runner และ scheduled-task จะจัดการรันเนอร์ที่โฮสต์เองและการดำเนินการตามกำหนดเวลา ซึ่งเป็นกลไกเดียวกันที่อยู่เบื้องหลัง การทดสอบ API ตามกำหนดเวลาใน Apidog
จัดการสัญญา API โดยไม่ต้องเปิดแอป
นี่คือส่วนที่ไม่มีเครื่องมือทดสอบเทอร์มินัลอื่นใดมี CLI เดียวกันที่รันการทดสอบของคุณสามารถอ่านและเขียนคำจำกัดความ API ได้:
apidog endpoint list --project <project_id>
apidog schema get <schema_id>
apidog environment list
apidog mock list
จุดเชื่อมต่อ (Endpoints), สคีมาข้อมูล, โฟลเดอร์, สภาพแวดล้อม, ตัวแปร, โครงสร้างความปลอดภัย (security schemes) และคอมโพเนนต์ที่นำกลับมาใช้ใหม่ได้ทั้งหมดสามารถสอบถามและแก้ไขได้ คำสั่ง mock จัดการการคาดการณ์ mock ซึ่งเป็นคู่คำขอ-ตอบกลับแบบตายตัวที่เซิร์ฟเวอร์ mock ของคุณส่งคืน คำสั่ง doc และ docs-site เกี่ยวข้องกับเอกสารที่เผยแพร่ จุดเชื่อมต่อ WebSocket และ Socket.IO มีกลุ่มของตัวเอง และ database-connection ครอบคลุมการกำหนดค่าฐานข้อมูลที่สถานการณ์การทดสอบของคุณอ่าน
การนำเข้าและส่งออกรองรับรูปแบบที่สำคัญ: OpenAPI 3.x และ Swagger 2.0 (ซึ่งเป็น ข้อมูลจำเพาะ ที่เครื่องมือส่วนใหญ่ยึดถือเป็นมาตรฐาน) รวมถึงคอลเลกชัน Postman สิ่งนี้ทำให้ CLI เป็นสะพานเชื่อมในสคริปต์การย้ายข้อมูล: ดึงข้อมูลจำเพาะจากระบบหนึ่ง ผลักดันเข้าไปใน Apidog และจัดเวอร์ชันการแลกเปลี่ยนทั้งหมด
apidog import openapi.json --project <project_id>
apidog export --format openapi
สร้างขึ้นเพื่อให้ AI agents สามารถขับเคลื่อนได้
การเปิดตัว CLI ในปี 2026 เน้นย้ำแนวคิดหนึ่งเป็นอย่างมาก: AI coding agent ควรจะสามารถดำเนินการพื้นที่ทำงาน API ของคุณได้อย่างปลอดภัยเช่นเดียวกับมนุษย์ มีสี่ส่วนที่ทำให้สิ่งนี้เป็นไปได้
ประการแรก, ผลลัพธ์ที่มีโครงสร้าง ทุกคำสั่งจะคืนค่า JSON ที่ agent สามารถแยกวิเคราะห์ได้ และ agentHints.nextSteps จะบอกให้มันทำอะไรหลังจากแต่ละผลลัพธ์ รวมถึงวิธีแก้ไขข้อผิดพลาด
ประการที่สอง, สคีมาอินพุตที่เผยแพร่ apidog cli-schema list และ apidog cli-schema get เปิดเผยรูปแบบ JSON ที่แน่นอนที่คำสั่งเขียนทุกคำสั่งคาดหวัง และ apidog cli-schema validate ตรวจสอบเพย์โหลดก่อนที่สิ่งใดจะแตะโปรเจกต์ พิธีการเขียนที่ปลอดภัยเหมือนเดิมเสมอ: รับสคีมา, สร้าง JSON, ตรวจสอบความถูกต้อง, และจากนั้นจึงรัน create หรือ update
ประการที่สาม, ทักษะที่บรรจุไว้ คำสั่ง skill จัดส่งความรู้การทำงานของ CLI ในรูปแบบที่ agent สามารถโหลดได้โดยตรง ซึ่งเป็นเรื่องราวเบื้องหลัง เหตุผลที่เราสร้าง Apidog CLI skill จากการวัดผลของเราเอง agent ที่ทำงานผ่านสคีมา CLI ใช้การเรียกเครื่องมือประมาณ 30% น้อยลง และใช้โทเค็น 25% น้อยลงเมื่อเทียบกับ agent ที่คาดเดาเพย์โหลด ตัวเลขถูกแบ่งย่อยอยู่ใน การวิเคราะห์นี้
ประการที่สี่, ประตูการอนุญาต โดยค่าเริ่มต้น การเขียนที่มาจาก AI ไปยังสาขาจะถูกบล็อกจนกว่ามนุษย์จะเปิดใช้งาน External AI Edit Permissions (ใน Apidog client 2.8.32 หรือใหม่กว่า ภายใต้ Project Settings, Feature Settings, AI Feature Settings) ทางเลือกอื่นคือ AI branch: สาขาที่แยกต่างหากที่ agent นำเข้าทรัพยากรที่ต้องการ ทำการแก้ไข และส่งผลลัพธ์คืนเป็นคำขอรวม (merge request) เพื่อตรวจสอบ AI branch ที่ไม่มีการแก้ไขจะถูกเก็บถาวรอัตโนมัติหลังจาก 24 ชั่วโมง ดังนั้นการทดลองจึงไม่สะสม สัญญา API ของคุณยังคงสามารถตรวจสอบได้แม้ว่า agent จะเขียนฉบับร่างแรกก็ตาม
Apidog CLI ไม่ใช่อะไร
สามข้อจำกัดที่ระบุไว้อย่างชัดเจน เพราะการเลือกเครื่องมือจากข้อมูลที่ซื่อสัตย์ดีกว่าการค้นพบช่องว่างในภายหลัง
มันไม่ใช่ไคลเอนต์คำขอแบบโต้ตอบ ไม่มีคำสั่งที่พิมพ์ POST เฉพาะกิจและพิมพ์ผลลัพธ์อย่างสวยงาม; curl, HTTPie และไคลเอนต์ TUI เป็นเจ้าของงานนั้น และพวกเขาก็ทำได้ดีกว่า
มันไม่ใช่โอเพ่นซอร์ส แพ็กเกจนี้เป็นกรรมสิทธิ์ npm เป็นช่องทางเดียวในการติดตั้ง และการทำอะไรที่นอกเหนือจาก --help จำเป็นต้องมีบัญชี Apidog ระดับฟรีครอบคลุมเวิร์กโฟลว์ทั้งหมดที่อธิบายไว้ในที่นี้ แต่หากใบอนุญาตที่ตรวจสอบได้เป็นข้อกำหนดที่เข้มงวด คำแนะนำที่ซื่อสัตย์คือรันเนอร์โอเพ่นซอร์ส
มันไม่ใช่แบบสแตนด์อโลน CLI เป็นส่วนหนึ่งของแพลตฟอร์มที่ทำงานบนเทอร์มินัล: สถานการณ์, จุดเชื่อมต่อ และสภาพแวดล้อมจะอยู่ในโปรเจกต์ Apidog ของคุณ ไม่ใช่ในไฟล์โลคัล นั่นคือการแลกเปลี่ยนที่ทำให้คุณมีแหล่งข้อมูลเดียวที่เป็นจริงสำหรับการออกแบบ, การทดสอบ, การจำลอง และเอกสาร
ตำแหน่งในชุดเครื่องมือเทอร์มินัล
เมื่อเทียบกับรันเนอร์อื่นๆ ความแตกต่างอยู่ที่การสร้าง Newman และ Postman CLI รันคอลเลกชันที่สร้างใน Postman; Hurl และ Bruno รันการทดสอบที่สร้างเป็นไฟล์ข้อความ; Apidog CLI รันสถานการณ์ที่สร้างในตัวแก้ไขภาพซึ่งเก็บสัญญา, mock และเอกสารของคุณด้วย การเปรียบเทียบ Apidog CLI กับ Newman ลงลึกมากขึ้น และมีการจัดอันดับเครื่องมือทั้งหมดในบทความ เครื่องมือทดสอบ API แบบเทอร์มินัลยอดนิยม
การตั้งค่าการทำงานสำหรับทีมส่วนใหญ่: เก็บ curl หรือ xh ไว้ในหน่วยความจำสำหรับการทดสอบเล็กๆ น้อยๆ และให้ apidog run ดำเนินการชุดการทดสอบใน CI คำแนะนำ GitHub Actions มีไพป์ไลน์แบบคัดลอกวางให้เริ่มต้นใช้งาน
คำถามที่พบบ่อย (FAQ)
Apidog CLI ใช้งานฟรีหรือไม่? ใช่ แพ็กเกจสามารถติดตั้งได้ฟรีจาก npm และระดับฟรีของ Apidog ครอบคลุมการสร้างสถานการณ์และการรันผ่าน CLI แผนแบบชำระเงินจะเพิ่มคุณสมบัติระดับทีม ไม่ใช่การเข้าถึง CLI ขั้นพื้นฐาน
มันมาแทนที่ curl หรือ HTTPie ได้หรือไม่? ไม่ และมันก็ไม่ได้พยายามที่จะทำเช่นนั้น เครื่องมือเหล่านั้นส่งคำขอเฉพาะกิจ; Apidog CLI รันสถานการณ์การทดสอบที่บันทึกไว้และจัดการทรัพยากรโปรเจกต์ เทอร์มินัลส่วนใหญ่จึงมีทั้งสองอย่าง
มันสามารถรันแบบ Headless ใน CI ได้อย่างสมบูรณ์หรือไม่? ใช่ รับรองความถูกต้องด้วย --access-token จาก CI secret รัน apidog run ด้วย ID สถานการณ์ของคุณ และควบคุมการสร้างด้วยรหัสออก ไม่จำเป็นต้องมีแอปเดสก์ท็อปบนรันเนอร์
มันสามารถนำเข้าและส่งออกรูปแบบใดได้บ้าง? OpenAPI 3.x, Swagger 2.0 และ Postman collections ทั้งสองทิศทาง ครอบคลุมการย้ายข้อมูลเข้าและการรวมเข้ากับระบบภายนอก
AI agents ใช้งานได้อย่างปลอดภัยได้อย่างไร? ผ่านพิธีการ schema-validate-write และประตูการอนุญาต: cli-schema validate จะดักจับเพย์โหลดที่มีรูปแบบผิดเพี้ยนก่อนที่จะถูกนำไปใช้ และ AI branches จะแยกการแก้ไขของ agent ออกไปจนกว่ามนุษย์จะรวมเข้าด้วยกัน ดูวิธีการทำงานภายใน agent ได้ใน วิธีการใช้ Apidog CLI ใน Claude Code
เทอร์มินัลคือที่ที่การทดสอบของคุณรันอยู่แล้ว และที่ที่ agent ของคุณทำงานอยู่แล้ว การนำไคลเอนต์ API ไปไว้ที่นั่นด้วยจะช่วยขจัดบริบทสวิตช์สุดท้าย ดาวน์โหลด Apidog, ติดตั้ง CLI จาก npm และรันสถานการณ์หนึ่งให้ครบถ้วน; หน้า Apidog CLI มีข้อมูลอ้างอิงคำสั่งฉบับเต็มเมื่อคุณพร้อมที่จะก้าวข้าม run