Không gian làm việc API của bạn nằm trong giao diện người dùng đồ họa (GUI). Ngày làm việc của bạn lại diễn ra trong một terminal. Mỗi lần chuyển đổi ngữ cảnh giữa hai môi trường này đều tốn vài giây và làm mất tập trung, và trong một quy trình CI (Continuous Integration) hoặc phiên làm việc của AI agent, GUI thậm chí không phải là một lựa chọn. Apidog CLI thu hẹp khoảng cách đó: nó mang toàn bộ nền tảng Apidog, các bài kiểm tra, điểm cuối, lược đồ, môi trường, kỳ vọng mock và tài liệu, đến dấu nhắc shell mà bạn đã mở.
Một định nghĩa trung thực trước khi đi vào chi tiết khác. Apidog CLI không phải là một curl khác. Nếu bạn muốn thực hiện một yêu cầu GET một lần và xem nhanh JSON, curl và HTTPie đã làm tốt điều đó, và bài tổng hợp các client REST giao diện người dùng terminal và TUI bao gồm khía cạnh tương tác. Apidog CLI là một client cho chính không gian làm việc API của bạn: nó chạy các kịch bản kiểm thử bạn đã xây dựng, đọc và cập nhật hợp đồng API, đồng thời di chuyển các thông số kỹ thuật vào và ra khỏi dự án, tất cả đều từ các lệnh mà một script hoặc một agent có thể gọi.
“Sống trong terminal của bạn” ở đây nghĩa là gì
Các công cụ HTTP trên terminal xử lý một yêu cầu tại một thời điểm. Apidog CLI hoạt động ở cấp độ dự án. Giao diện lệnh của nó bao gồm hơn bốn mươi nhóm, và chúng được gom lại thành năm công việc:
| Công việc | Lệnh |
|---|---|
| Chạy kiểm thử | run, test-scenario, test-suite, test-case, test-data, test-report |
| Quản lý hợp đồng | endpoint, schema, folder, common-parameter, response-component, security-scheme |
| Phát hành tài liệu và mock | doc, docs-site, shared-doc, mock |
| Cấu hình và kết nối | environment, variables, vault, database-connection, websocket, socketio |
| Hoạt động theo nhóm | branch, merge-request, runner, scheduled-task, audit-log, import, export |
Mỗi lệnh đều hỗ trợ --help, đầu ra là JSON có cấu trúc, và hầu hết các phản hồi đều bao gồm agentHints.nextSteps cho bạn (hoặc agent của bạn) biết nên chạy gì tiếp theo. Chi tiết cuối cùng này nghe có vẻ nhỏ. Nó thay đổi cảm nhận về công cụ: CLI hướng dẫn quy trình làm việc thay vì giả định bạn đã ghi nhớ nó.
Cài đặt chỉ với một lệnh
CLI được phân phối dưới dạng gói npm (apidog-cli) và chạy trên macOS, Linux và Windows. Nó yêu cầu Node.js 16 trở lên.
npm install -g apidog-cli
apidog --version
Sau đó, đăng nhập bằng API access token. Lấy nó từ ứng dụng Apidog: nhấp vào hình đại diện của bạn, mở Cài đặt tài khoản (Account Settings), và sao chép token trong phần API Access Token.
apidog login --with-token <YOUR_TOKEN>
Token được lưu vào ~/.apidog/config.toml, vì vậy hãy giữ nó khỏi các kho lưu trữ và nhật ký của bạn; trong CI, hãy truyền nó cho mỗi lần chạy với --access-token từ một bí mật thay thế. Bốn cờ toàn cục bao gồm hầu hết ngữ cảnh: --project chọn dự án, --branch chọn nhánh, --access-token ghi đè thông tin đăng nhập đã lưu và --api-base-url trỏ CLI tới một triển khai Apidog tự lưu trữ. Hướng dẫn xác thực Apidog CLI trình bày chi tiết về các token cho CI.
Chạy các bài kiểm thử bạn đã xây dựng một cách trực quan
Đây là quy trình làm việc mà CLI được xây dựng xung quanh. Bạn tạo một kịch bản kiểm thử trong trình chỉnh sửa trực quan của Apidog: các yêu cầu chuỗi, các biến được trích xuất từ một phản hồi và chèn vào yêu cầu tiếp theo, các xác nhận về trạng thái và nội dung. Sau đó, bạn chạy nó ở bất cứ đâu có shell.
# Sao chép lệnh này, bao gồm ID, từ tab CI/CD của kịch bản
apidog run -t <scenario_id> -e <env_id> -r cli
Lệnh thoát với mã 0 khi mọi xác nhận đều thành công và khác 0 khi có bất kỳ lỗi nào, vì vậy một pipeline có thể dựa vào nó mà không cần thêm bất kỳ cấu hình nào. Thay đổi -e để trỏ cùng một kịch bản tới các môi trường phát triển, staging hoặc production. Cung cấp cho nó một tệp CSV hoặc JSON và nó sẽ lặp lại kịch bản qua mỗi hàng, đó là cách kiểm thử dựa trên dữ liệu hoạt động mà không cần lặp lại các bước. Nếu bạn mới bắt đầu, hướng dẫn từng bước kiểm thử REST API sẽ đưa bạn từ cài đặt đến lần chạy thành công đầu tiên.
Các báo cáo được xuất ra ở bốn định dạng: cli in kết quả từng bước ra terminal, trong khi html, json và junit được lưu vào thư mục apidog-reports/ cho các bảng điều khiển và các tạo phẩm CI. Bạn có thể kết hợp chúng một cách tự do, như trong -r cli,junit. Hướng dẫn báo cáo kiểm thử cho thấy mỗi định dạng trông như thế nào.
Đối với các lần chạy không nên phụ thuộc vào máy tính xách tay của bạn, các lệnh runner và scheduled-task quản lý các runner tự lưu trữ và các lần thực thi theo lịch trình, cùng một cơ chế đằng sau các bài kiểm thử API theo lịch trình trong Apidog.
Quản lý hợp đồng API mà không cần mở ứng dụng
Đây là phần mà không có công cụ kiểm thử terminal nào khác có. Cùng một CLI chạy các bài kiểm thử của bạn có thể đọc và ghi định nghĩa API đó:
apidog endpoint list --project <project_id>
apidog schema get <schema_id>
apidog environment list
apidog mock list
Các điểm cuối (endpoints), lược đồ dữ liệu (data schemas), thư mục (folders), môi trường (environments), biến (variables), lược đồ bảo mật (security schemes) và các thành phần có thể tái sử dụng (reusable components) đều có thể truy vấn và chỉnh sửa được. Lệnh mock quản lý các kỳ vọng mock (mock expectations), tức là các cặp yêu cầu-phản hồi cố định mà máy chủ mock của bạn trả về. Các lệnh doc và docs-site xử lý tài liệu đã xuất bản. Các điểm cuối WebSocket và Socket.IO có các nhóm riêng, và database-connection bao gồm các cấu hình cơ sở dữ liệu mà các kịch bản kiểm thử của bạn đọc.
Nhập và xuất hỗ trợ các định dạng quan trọng: OpenAPI 3.x và Swagger 2.0 (là đặc tả mà hầu hết các chuỗi công cụ chuẩn hóa), cộng với Postman collections. Điều này làm cho CLI trở thành một cầu nối trong các script di chuyển: kéo một đặc tả từ một hệ thống, đẩy nó vào Apidog, và quản lý phiên bản toàn bộ quá trình trao đổi.
apidog import openapi.json --project <project_id>
apidog export --format openapi
Được xây dựng để AI agents có thể điều khiển
Các bản phát hành năm 2026 của CLI tập trung mạnh vào một ý tưởng: một AI coding agent có thể vận hành không gian làm việc API của bạn an toàn như một người. Bốn yếu tố giúp điều đó hoạt động.
Đầu tiên, đầu ra có cấu trúc. Mỗi lệnh trả về JSON mà một agent có thể phân tích cú pháp, và agentHints.nextSteps cho nó biết phải làm gì sau mỗi kết quả, bao gồm cả cách khôi phục sau lỗi.
Thứ hai, một lược đồ đầu vào được công bố. apidog cli-schema list và apidog cli-schema get hiển thị chính xác hình dạng JSON mà mọi lệnh ghi mong đợi, và apidog cli-schema validate kiểm tra một payload trước khi bất cứ điều gì chạm vào dự án. Quy trình ghi an toàn luôn giống nhau: lấy lược đồ, tạo JSON, xác thực nó, và chỉ sau đó chạy create hoặc update.
Thứ ba, một kỹ năng được đóng gói. Lệnh skill cung cấp kiến thức vận hành của CLI dưới dạng mà các agent có thể tải trực tiếp, đó là câu chuyện đằng sau lý do chúng tôi xây dựng kỹ năng Apidog CLI. Trong các phép đo của chúng tôi, các agent làm việc thông qua lược đồ CLI sử dụng ít hơn khoảng 30% các lệnh gọi công cụ và ít hơn 25% token so với các agent đoán payload; các số liệu được phân tích chi tiết trong bài phân tích này.
Thứ tư, các cổng cấp phép. Theo mặc định, các thao tác ghi do AI thực hiện vào một nhánh bị chặn cho đến khi con người bật Quyền chỉnh sửa AI bên ngoài (External AI Edit Permissions) (trong Apidog client 2.8.32 trở lên, dưới Cài đặt dự án, Cài đặt tính năng, Cài đặt tính năng AI). Giải pháp thay thế là một nhánh AI: một nhánh độc lập nơi một agent nhập các tài nguyên cần thiết, thực hiện chỉnh sửa và trả lại kết quả dưới dạng yêu cầu hợp nhất để xem xét. Các nhánh AI không được chạm vào sẽ tự động lưu trữ sau 24 giờ, vì vậy các thử nghiệm không bị chồng chất. Hợp đồng API của bạn vẫn có thể được xem xét ngay cả khi một agent viết bản nháp đầu tiên.
Apidog CLI không phải là gì
Ba giới hạn, được trình bày rõ ràng, vì chọn công cụ dựa trên thông tin trung thực tốt hơn là phát hiện ra những lỗ hổng sau này.
Nó không phải là một client yêu cầu tương tác. Không có lệnh nào gõ một POST ngẫu hứng và định dạng đẹp mắt phản hồi; curl, HTTPie và các client TUI làm tốt công việc đó, và chúng tốt hơn ở khía cạnh đó.
Nó không phải là mã nguồn mở. Gói này là độc quyền, npm là kênh cài đặt duy nhất, và để làm bất cứ điều gì ngoài --help đều yêu cầu một tài khoản Apidog. Gói miễn phí bao gồm toàn bộ quy trình làm việc được mô tả ở đây, nhưng nếu giấy phép có thể kiểm toán là một yêu cầu cứng rắn, thì một runner mã nguồn mở là khuyến nghị trung thực.
Nó không độc lập. CLI là cánh tay terminal của nền tảng: các kịch bản, điểm cuối và môi trường sống trong dự án Apidog của bạn, không phải trong các tệp cục bộ. Đó là sự đánh đổi mang lại cho bạn một nguồn thông tin duy nhất trên thiết kế, kiểm thử, mocking và tài liệu.
Nó phù hợp ở đâu trong bộ công cụ terminal
So với các runner khác, sự khác biệt nằm ở nơi tạo tác. Newman và Postman CLI chạy các collection được tạo trong Postman; Hurl và Bruno chạy các bài kiểm thử được tạo dưới dạng tệp văn bản; Apidog CLI chạy các kịch bản được tạo trong một trình chỉnh sửa trực quan cũng chứa hợp đồng, mock và tài liệu của bạn. Bài so sánh Apidog CLI vs Newman đi sâu hơn, và toàn bộ lĩnh vực được xếp hạng trong bài tổng hợp các công cụ kiểm thử API dựa trên terminal hàng đầu.
Một thiết lập hoạt động cho hầu hết các nhóm: giữ curl hoặc xh trong bộ nhớ cơ bắp để kiểm tra nhanh, và để apidog run thực hiện các bộ kiểm thử trong CI. Hướng dẫn GitHub Actions có một pipeline copy-paste để bắt đầu.
FAQ
Apidog CLI có miễn phí sử dụng không? Có. Gói cài đặt miễn phí từ npm, và gói miễn phí của Apidog bao gồm việc xây dựng các kịch bản và chạy chúng thông qua CLI. Các gói trả phí bổ sung các tính năng cấp đội nhóm, không phải quyền truy cập CLI cơ bản.
Nó có thay thế curl hoặc HTTPie không? Không, và nó không cố gắng. Các công cụ đó gửi các yêu cầu ngẫu hứng; Apidog CLI chạy các kịch bản kiểm thử đã lưu và quản lý tài nguyên dự án. Hầu hết các terminal đều kết thúc bằng cả hai.
Nó có thể chạy hoàn toàn không giao diện (headless) trong CI không? Có. Xác thực bằng --access-token từ một bí mật CI, chạy apidog run với ID kịch bản của bạn, và kiểm soát bản dựng dựa trên mã thoát. Không cần ứng dụng máy tính để bàn trên runner.
Nó có thể nhập và xuất các định dạng nào? OpenAPI 3.x, Swagger 2.0, và Postman collections, theo cả hai hướng. Điều đó bao gồm việc di chuyển vào và tích hợp ra ngoài.
Làm thế nào để AI agents sử dụng nó một cách an toàn? Thông qua quy trình schema-validate-write và các cổng cấp phép: cli-schema validate bắt các payload bị định dạng sai trước khi chúng được đưa vào, và các nhánh AI giữ các chỉnh sửa của agent được cô lập cho đến khi con người hợp nhất chúng. Xem nó hoạt động bên trong một agent trong cách sử dụng Apidog CLI trong Claude Code.
Terminal là nơi các bài kiểm thử của bạn đã chạy và nơi các agent của bạn đã làm việc. Đặt client API ở đó nữa loại bỏ lần chuyển đổi ngữ cảnh cuối cùng. Tải xuống Apidog, cài đặt CLI từ npm, và chạy một kịch bản từ đầu đến cuối; trang Apidog CLI có tài liệu tham khảo lệnh đầy đủ khi bạn đã sẵn sàng vượt qua run.