Apidog CLI từ lâu đã là điểm truy cập dòng lệnh để chạy kiểm thử API từ terminal, pipeline CI, workflow tự động hóa hoặc hệ thống bên ngoài.
apidog run --project <projectId> --test-scenario <scenarioId> --environment <environmentId>
Nền tảng này vẫn quan trọng: nhóm phát triển cần một cách ổn định để chạy kiểm thử API, tạo báo cáo và giữ quality gate trong CI. Nhưng workflow API hiện nay không chỉ có con người thao tác trong UI. AI Agent cũng có thể tham gia thiết kế API, tạo test, gỡ lỗi, di chuyển và bảo trì tài sản API.
Vì vậy, CLI không nên chỉ là bước cuối để chạy test có sẵn. CLI cần cung cấp một lớp thao tác có cấu trúc để Agent có thể:
- Đọc tài sản API hiện có.
- Tạo hoặc cập nhật test case, test scenario.
- Xác thực dữ liệu có cấu trúc trước khi ghi.
- Ghi thay đổi trở lại Apidog.
- Đọc lại kết quả và chạy kiểm thử để xác minh.
Apidog CLI được nâng cấp vẫn giữ khả năng chạy kiểm thử ban đầu, đồng thời mở rộng thành lớp workflow cho developer, script và AI Agent.
Vì sao CLI quan trọng hơn trong kỷ nguyên AI Agent
Giao diện đồ họa phù hợp với con người: trực quan, linh hoạt và tốt cho khám phá. Nhưng AI Agent hoạt động hiệu quả hơn với:
- Lệnh có cấu trúc.
- Input có thể dự đoán.
- Output có thể parse được.
- Bước xác thực rõ ràng.
- Quy trình có thể lặp lại.
CLI là giao diện phù hợp cho các workflow đó. Với Apidog CLI, Agent và script có thể làm việc với cùng các tài nguyên mà developer quản lý trong Apidog, bao gồm API, môi trường, biến, test case, test scenario, test suite, báo cáo, import/export và các tài nguyên dự án liên quan.
Cách tiếp cận thực tế là:
- Developer tiếp tục thiết kế, debug, review và cộng tác trong Apidog UI.
- Script và AI Agent dùng CLI để thao tác có kiểm soát trên các tài sản đó.
Từ apidog run đến workflow API và kiểm thử hoàn chỉnh
Trước đây, CLI chủ yếu tập trung vào thực thi kiểm thử. Điều này làm cho apidog run rất hữu ích trong CI, nhưng CLI thường chỉ xuất hiện ở cuối workflow.
CLI được nâng cấp mở rộng phạm vi thao tác trên nhiều tài nguyên Apidog hơn. Nhờ đó, tự động hóa có thể tham gia sớm hơn trong vòng đời phát triển API: đọc ngữ cảnh dự án, chuẩn bị tài sản kiểm thử, xác thực thay đổi và sau đó chạy kiểm thử.
Với CLI được nâng cấp, bạn có thể xây dựng workflow xoay quanh các tài nguyên như:
- Dự án và metadata của dự án.
- API và định nghĩa API.
- Môi trường và biến.
- Test case.
- Test scenario.
- Test suite.
- Báo cáo.
- Import/export dữ liệu.
- Tài khoản, nhánh, runner và tài nguyên liên quan đến dự án.
Điểm thay đổi chính: Apidog CLI không chỉ chạy test sau khi mọi thứ đã xong. Nó có thể tham gia vào các bước trước đó, nơi Agent cần hiểu dự án, tạo hoặc cập nhật tài sản kiểm thử, xác thực thay đổi và chạy xác minh.
Vòng lặp an toàn hơn cho kiểm thử do Agent điều khiển
Khi AI Agent hỗ trợ phát triển hoặc kiểm thử API, rủi ro không chỉ nằm ở việc tạo nội dung. Rủi ro lớn hơn là ghi nội dung được tạo vào dự án thật mà chưa có đủ kiểm tra về cấu trúc và tính đúng đắn.
Một workflow an toàn hơn nên có dạng:
Trong thực tế, nhiều tài nguyên Apidog có cấu trúc phức tạp. Test case và test scenario có thể bao gồm:
- Request data.
- Assertion.
- Variable extraction.
- Pre-processor.
- Post-processor.
- Thứ tự step.
- Tham chiếu đến environment.
- Các cấu hình thực thi khác.
Nếu Agent tự đoán cấu trúc JSON, lỗi nhỏ có thể dẫn đến ghi thất bại, hiển thị không đầy đủ trong UI hoặc test chạy sai kỳ vọng.
Đó là lý do cli-schema là một phần quan trọng trong bản nâng cấp. Trước khi ghi một file JSON phức tạp vào Apidog, hãy dùng CLI để xác thực schema.
apidog cli-schema validate test-case-create --file ./test-case-create.json
apidog cli-schema validate test-scenario-update --file ./scenario-update.json
Nguyên tắc triển khai đơn giản:
Agent tạo nội dung → CLI xác thực schema → CLI ghi vào Apidog → đọc lại → chạy test
Nói cách khác: hãy để Agent tạo, nhưng để CLI xác thực trước khi ghi.
CLI cũng có thể đưa ra gợi ý định hướng Agent trong output lệnh. Sau khi tạo hoặc cập nhật tài nguyên, bước tiếp theo không nên là dừng lại. Agent đáng tin cậy hơn nên đọc lại tài nguyên đã lưu, xác nhận cấu trúc và chạy kiểm thử nếu phù hợp.
Skills cung cấp cho Agent khả năng đánh giá vận hành
Lệnh CLI cho Agent khả năng thực thi. Skills giúp Agent có khả năng đánh giá workflow.
Một Skill không chỉ là tài liệu tham khảo lệnh. Nó giống một hướng dẫn vận hành cho AI Agent, mô tả:
- Khi nào nên dùng lệnh nào.
- Lệnh nào nên chạy trước.
- Trường nào không nên đoán.
- Khi nào cần xác thực schema.
- Khi nào cần đọc lại tài nguyên.
- Khi nào nên chạy kiểm thử.
Ví dụ, với một test scenario lớn, Agent không nên luôn tạo toàn bộ scenario từ đầu trong một lần. Một workflow an toàn hơn là:
- Tạo scenario cơ bản.
- Import step từ API hoặc test case hiện có.
- Đọc lại cấu trúc scenario đầy đủ.
- Cập nhật assertion, variable extraction hoặc processor theo từng bước nhỏ.
- Xác thực và chạy scenario.
Skills giúp các pattern này trở nên rõ ràng hơn, đồng thời giảm các lỗi phổ biến như:
- Dùng sai tên trường.
- Chọn sai giá trị enum.
- Bỏ qua schema validation.
- Cho rằng ghi thành công đồng nghĩa tài nguyên cuối cùng đã đúng.
Apidog cung cấp 8 Skills đi kèm để giúp Agent hiểu lệnh CLI, cấu trúc tài nguyên và workflow tác vụ. Khi kết hợp CLI và Skills, Apidog trở nên thực tế hơn cho phát triển và kiểm thử API có hỗ trợ AI.
Thay đổi dự án an toàn hơn với AI Branches
Khi Agent sửa đổi tài nguyên dự án, bạn cần kiểm soát rủi ro và khả năng review. Vì vậy, CLI được nâng cấp cũng có thể dùng cùng AI Branches.
Workflow khuyến nghị:
- Agent thực hiện thay đổi trong một nhánh biệt lập.
- Nhóm review khác biệt.
- Chạy kiểm thử để xác nhận.
- Merge vào nhánh đích nếu kết quả đúng.
Cách này giúp tránh việc thay đổi tự động ảnh hưởng trực tiếp đến nhánh chính hoặc nhánh cộng tác dùng chung.
Các workflow thực tế có thể triển khai
Giá trị của CLI được nâng cấp thể hiện rõ nhất khi áp dụng vào các workflow cụ thể.
1. Tạo kiểm thử từ định nghĩa API
Một Agent có thể đọc định nghĩa API từ dự án, tạo test case, xác thực JSON bằng cli-schema, ghi test case vào Apidog, đọc lại kết quả và chạy kiểm thử.
Workflow mẫu:
Đọc API definition
→ Sinh test case JSON
→ Validate bằng cli-schema
→ Ghi test case vào Apidog
→ Đọc lại test case
→ Chạy kiểm thử
Điểm quan trọng là không biến việc tạo test thành một prompt đơn lẻ. Hãy biến nó thành workflow có bước xác thực rõ ràng.
2. Duy trì test scenario phức tạp
Với scenario nhiều bước, Agent nên bắt đầu từ tài sản hiện có thay vì tự dựng toàn bộ từ đầu.
Ví dụ:
apidog test-scenario import-steps <scenarioId> --project <projectId> --source endpoint --ids <endpointIds> --sync manual
apidog test-scenario get <scenarioId> --project <projectId> --with-case-detail
Sau khi import step, Agent có thể đọc lại cấu trúc đầy đủ rồi cập nhật assertion, biến hoặc processor theo từng thay đổi nhỏ. Cách này giảm rủi ro tạo ra một scenario lớn nhưng sai cấu trúc.
3. Di chuyển và tái tạo tài sản dự án
CLI được nâng cấp cũng hỗ trợ tốt hơn cho import/export dữ liệu gốc của Apidog. Điều này hữu ích khi bạn cần:
- Di chuyển dự án.
- Tái tạo môi trường khách hàng.
- Sao chép thiết lập kiểm thử.
- Di chuyển API, schema, test case và scenario giữa các dự án.
Ví dụ:
apidog export --project <projectId> --format apidog --output ./project.apidog.json
apidog import --project <projectId> --format apidog --file ./project.apidog.json
4. Duy trì quality gate trong CI
Các khả năng mới cho Agent không thay thế CI. Chúng bổ sung cho CI.
Bạn vẫn có thể dùng apidog run làm điểm thực thi kiểm thử cốt lõi trong pipeline:
apidog run --project <projectId> --test-scenario <scenarioId> --environment <environmentId> -r "cli,html,junit" --out-dir ./apidog-reports
Ví dụ trong pipeline, bạn có thể dùng output report để lưu artifact hoặc tích hợp với hệ thống CI hiện có.
Bắt đầu với Apidog CLI
Nếu bạn đã cài Apidog CLI, kiểm tra phiên bản hiện tại:
apidog -v
Nếu phiên bản Apidog CLI của bạn thấp hơn 2.2.5, hãy cập nhật CLI trước khi dùng các khả năng mới. Số phiên bản này là của Apidog CLI, không phải ứng dụng Apidog.
Bạn có thể yêu cầu AI Agent cài đặt Apidog CLI và Skills đi kèm bằng prompt sau:
Read the instructions and help me install Apidog CLI:
https://apidog.com/apidog-cli-installation-guide.md?utm_source=dev.to&utm_medium=wanda&utm_content=n8n-post-automation
Nếu muốn cài đặt hoặc cập nhật thủ công, chạy:
npm install -g apidog-cli@latest
Để xem đầy đủ các lệnh, tham khảo Tùy chọn Apidog CLI.
Thử tác vụ Agent đầu tiên
Sau khi CLI và Skills đã được cài đặt, hãy bắt đầu bằng một tác vụ nhỏ, rủi ro thấp. Ví dụ: yêu cầu Agent tạo một endpoint kiểm tra sức khỏe đơn giản trong dự án Apidog, sau đó đọc lại để xác nhận kết quả.
Sao chép prompt sau vào AI Agent của bạn:
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.
Prompt này buộc Agent thực hiện các bước an toàn:
- Kiểm tra thiết lập CLI.
- Liệt kê dự án có thể truy cập.
- Hỏi bạn trước khi ghi vào dự án.
- Tạo endpoint nhỏ.
- Xác thực input có cấu trúc.
- Đọc lại endpoint đã tạo.
- Tóm tắt kết quả.
Các bước tiếp theo:
- Tải xuống Apidog để thiết kế, gỡ lỗi, kiểm thử và tài liệu hóa API trong một workspace.
- Tìm hiểu thêm về Apidog CLI để kiểm thử API dòng lệnh, tự động hóa CI và workflow AI Agent.
Câu hỏi thường gặp
Apidog CLI là gì?
Apidog CLI là công cụ dòng lệnh để chạy kiểm thử API, làm việc với tài nguyên dự án Apidog và kết nối tài sản API/kiểm thử của Apidog với các workflow tự động hóa.
Apidog CLI có thể chạy kiểm thử API trong CI không?
Có. Bạn có thể dùng apidog run trong pipeline CI để chạy kiểm thử API, tạo báo cáo và duy trì quality gate tự động.
Apidog CLI giúp AI Agent như thế nào?
Apidog CLI cung cấp cho AI Agent một cách có cấu trúc để đọc thông tin API, tạo hoặc cập nhật tài sản kiểm thử, xác thực thay đổi, ghi vào Apidog, đọc lại kết quả và chạy kiểm thử để xác minh.
cli-schema trong Apidog CLI là gì?
cli-schema giúp xác thực các file JSON phức tạp trước khi ghi vào Apidog. Điều này giảm lỗi ghi, trường không hợp lệ và vòng lặp thử lại không cần thiết khi Agent tạo hoặc cập nhật test case và test scenario.
Làm cách nào để cài đặt Apidog CLI?
Bạn có thể yêu cầu AI Agent làm theo hướng dẫn cài đặt Apidog CLI để cài CLI và Skills đi kèm. Nếu cài thủ công, dùng:
bash
npm install -g apidog-cli@latest
Top comments (0)