Apidog CLI từ lâu đã là điểm truy cập dòng lệnh để chạy các bài kiểm tra API từ một terminal, pipeline CI, quy trình làm việc 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 đó vẫn rất quan trọng. Các nhóm vẫn cần một cách đáng tin cậy để chạy các bài kiểm tra API, tạo báo cáo và giữ các cổng chất lượng bên trong CI. Nhưng phát triển API đang thay đổi. Các AI Agent hiện đang tham gia vào việc thiết kế API, tạo bài kiểm tra, gỡ lỗi, di chuyển và bảo trì.
Đối với các quy trình làm việc đó, CLI không chỉ có thể là bước cuối cùng chạy các bài kiểm tra hiện có. Nó cũng cần cung cấp cho các Agent một cách ổn định để đọc các tài sản API, tạo hoặc cập nhật các tài sản kiểm thử, xác thực các thay đổi có cấu trúc, ghi chúng trở lại và xác minh kết quả.
Apidog CLI được nâng cấp vẫn giữ nguyên nền tảng chạy kiểm thử ban đầu và mở rộng nó thành một lớp quy trình làm việc cho các nhà phát triển, script và AI Agent. Bài viết này giải thích tại sao CLI trở nên quan trọng hơn trong kỷ nguyên AI Agent, những gì đã thay đổi trong Apidog CLI và cách các nhóm có thể bắt đầu sử dụng nó để tự động hóa kiểm thử API.
Tại sao CLI quan trọng hơn trong kỷ nguyên AI Agent
Giao diện đồ họa được thiết kế cho con người. Chúng trực quan, linh hoạt và hữu ích cho việc khám phá. Tuy nhiên, các AI Agent hoạt động tốt nhất với các lệnh có cấu trúc, đầu vào có thể dự đoán, đầu ra có thể dự đoán và các bước xác thực rõ ràng.
Đó là nơi CLI trở nên quan trọng. CLI cung cấp cho các Agent và script một giao diện lặp lại cho cùng các tài nguyên mà nhà phát triển quản lý trong Apidog: API, môi trường, biến, trường hợp kiểm thử, kịch bản kiểm thử, bộ kiểm thử, báo cáo, nhập/xuất dữ liệu, v.v.
Trong thực tế, điều này có nghĩa là Apidog có thể phục vụ cả người dùng và quy trình làm việc tự động. Mọi người tiếp tục thiết kế, gỡ lỗi, xem xét và cộng tác trong giao diện sản phẩm. Các Agent và tự động hóa có thể sử dụng CLI để thực hiện các hoạt động được kiểm soát xung quanh các tài sản đó.
Từ apidog run đến các quy trình làm việc API và kiểm thử hoàn chỉnh
Trải nghiệm CLI trước đây chủ yếu tập trung vào việc thực thi kiểm thử. Điều đó làm cho apidog run hữu ích như một cổng chất lượng CI, nhưng nó cũng có nghĩa là CLI thường xuất hiện gần cuối quy trình làm việc. CLI được nâng cấp mở rộng phạm vi bao phủ trên nhiều tài nguyên Apidog cốt lõi hơn, do đó tự động hóa có thể tham gia sớm hơn: đọc ngữ cảnh dự án, chuẩn bị tài sản kiểm thử, xác thực các thay đổi có cấu trúc và sau đó chạy xác minh.
Với CLI được nâng cấp, người dùng và Agent có thể làm việc với các tài nguyên như:
- Dự án và siêu dữ liệu dự án
- API và định nghĩa API
- Môi trường và biến
- Các trường hợp kiểm thử
- Các kịch bản kiểm thử
- Bộ kiểm thử
- Báo cáo
- Quy trình nhập và xuất
- Tài khoản, nhánh, runner và các tài nguyên dự án liên quan
Điều này thay đổi vai trò của Apidog CLI. Nó không chỉ đơn thuần là một cách để thực thi các bài kiểm thử sau khi mọi thứ khác đã hoàn thành. Giờ đây, nó có thể tham gia sớm hơn vào vòng lặp phát triển, nơi một 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 các thay đổi và sau đó chạy xác minh.
Một vòng lặp an toàn hơn cho kiểm thử do Agent điều khiển
Khi một AI Agent hỗ trợ phát triển hoặc kiểm thử API, phần rủi ro không chỉ là tạo nội dung. Phần rủi ro là ghi nội dung đã tạo vào một dự án thực mà không có đủ cấu trúc hoặc xác minh.
CLI được nâng cấp giúp tạo ra một vòng lặp an toàn hơn:
Vòng lặp này quan trọng vì nhiều tài nguyên Apidog có cấu trúc. Các trường hợp kiểm thử và kịch bản kiểm thử có thể bao gồm dữ liệu yêu cầu, xác nhận, trích xuất biến, pre-processor, post-processor, thứ tự bước, tham chiếu đến môi trường và các chi tiết khác. Nếu một Agent đoán cấu trúc, những lỗi nhỏ có thể gây ra lỗi ghi, hiển thị không đầy đủ trong UI hoặc các bài kiểm thử không hoạt động như mong đợi.
Đó là lý do tại sao cli-schema là một phần quan trọng của bản nâng cấp. Trước khi ghi một tệp JSON phức tạp vào Apidog, một Agent có thể yêu cầu CLI xác thực xem các trường và cấu trúc có khớp với schema mong đợi hay không.
apidog cli-schema validate test-case-create --file ./test-case-create.json
apidog cli-schema validate test-scenario-update --file ./scenario-update.jsonNói tóm lại: hãy để Agent tạo, nhưng hãy để CLI xác thực trước khi ghi xảy ra.
CLI cũng có thể cung cấp các gợi ý định hướng Agent trong đầu ra lệnh. Sau khi một tài nguyên được tạo hoặc cập nhật, bước tiếp theo thường không phải là “dừng lại”. Một 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 các bài kiểm thử khi thích hợp. Những gợi ý này giúp các Agent di chuyển qua quy trình làm việc với ít điểm mù hơn.
Skills cung cấp cho Agent khả năng đánh giá vận hành
Các lệnh CLI cung cấp cho Agent quyền thực thi. Skills cung cấp cho Agent khả năng đánh giá vận hành.
Một SKILL không chỉ là một tài liệu tham khảo lệnh. Nó gần giống như một hướng dẫn vận hành được viết cho AI Agent: khi nào nên sử dụng một lệnh, lệnh nào nên đứng trước, trường nào không nên đoán, khi nào nên xác thực, khi nào nên đọc lại và khi nào nên chạy kiểm thử.
Ví dụ, một Agent đáng tin cậy không nên luôn tự viết một kịch bản kiểm thử lớn từ đầu. Một mẫu an toàn hơn thường là:
- Tạo kịch bản cơ bản.
- Nhập các bước từ API hoặc các trường hợp kiểm thử hiện có.
- Đọc lại cấu trúc kịch bản đầy đủ.
- Cập nhật các xác nhận, trích xuất biến hoặc bộ xử lý trong các bước nhỏ hơn.
- Xác thực và chạy kịch bản.
Skills làm cho các mẫu này trở nên rõ ràng. Chúng giúp các Agent tránh các lỗi phổ biến như sử dụng sai tên trường, chọn sai giá trị enum, bỏ qua xác thực schema hoặc cho rằng việc ghi thành công có nghĩa là tài nguyên cuối cùng đã đúng.
Apidog cung cấp 8 Skills đi kèm để giúp các Agent hiểu các lệnh CLI, cấu trúc tài nguyên và quy trình làm việc tác vụ. Cùng nhau, CLI và Skills làm cho Apidog thực tế hơn cho việc 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 một Agent sửa đổi tài nguyên dự án, tính an toàn và khả năng xem xét lại là rất quan trọng. Vì lý do đó, CLI được nâng cấp cũng có thể được sử dụng cùng với AI Branches.
Agent có thể thực hiện các thay đổi trong một nhánh biệt lập trước. Nhóm có thể xem xét sự khác biệt, xác nhận kết quả, sau đó hợp nhất vào nhánh đích. Điều này giúp ngăn chặn cá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.
Điều này mở khóa gì trong các quy trình làm việc thực tế
Giá trị của CLI được nâng cấp dễ thấy nhất trong các quy trình làm việc cụ thể.
Tạo kiểm thử từ định nghĩa API
Một Agent có thể đọc các định nghĩa API từ một dự án, tạo các trường hợp kiểm thử, xác thực JSON đã tạo bằng cli-schema, ghi các trường hợp kiểm thử vào Apidog, đọc lại chúng và chạy xác minh. Điều này biến việc tạo kiểm thử từ một gợi ý đơn lẻ thành một quy trình làm việc được kiểm soát.
Duy trì các kịch bản kiểm thử phức tạp
Đối với các kịch bản đa bước, Agent có thể nhập các bước từ API hoặc các trường hợp kiểm thử hiện có trước, sau đó cập nhật các xác nhận, biến hoặc bộ xử lý sau khi đọc lại cấu trúc hoàn chỉnh. Điều này giảm thiểu rủi ro xây dựng một kịch bản lớn không chính xác trong một lần.
apidog test-scenario import-steps <scenarioId> --project <projectId> --source endpoint --ids <endpointIds> --sync manual
apidog test-scenario get <scenarioId> --project <projectId> --with-case-detailDi chuyển và tái tạo tài sản dự án
CLI được nâng cấp cũng cải thiện quy trình nhập và xuất dữ liệu gốc của Apidog. Điều này hữu ích cho việc 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ử hoặc di chuyển API, schema, trường hợp kiểm thử và kịch bản giữa các dự án.
apidog export --project <projectId> --format apidog --output ./project.apidog.json
apidog import --project <projectId> --format apidog --file ./project.apidog.jsonDuy trì cổng chất lượng CI
Các khả năng mới sẵn sàng cho Agent không thay thế CI. Chúng bổ sung cho CI. Các nhóm vẫn có thể sử dụng apidog run làm điểm truy cập cốt lõi để thực thi kiểm thử và báo cáo tự động.
apidog run --project <projectId> --test-scenario <scenarioId> --environment <environmentId> -r "cli,html,junit" --out-dir ./apidog-reportsBắt đầu
Nếu bạn đã cài đặt Apidog CLI, trước tiên hãy kiểm tra phiên bản hiện tại của bạn:
apidog -vNếu phiên bản Apidog CLI của bạn sớm hơn 2.2.5, hãy cập nhật CLI trước khi sử dụng các khả năng mới. Số phiên bản này đề cập đến Apidog CLI, không phải ứng dụng Apidog.
Bạn có thể yêu cầu AI Agent mà bạn đang sử dụng cài đặt cả Apidog CLI và các Skills đi kèm bằng cách sao chép lời nhắc này:
Read the instructions and help me install Apidog CLI:
https://apidog.com/apidog-cli-installation-guide.mdNếu bạn muốn cài đặt hoặc cập nhật thủ công, hãy chạy:
npm install -g apidog-cli@latestĐể tham khảo đầy đủ các lệnh, hãy xem Tùy chọn Apidog CLI.
Thử tác vụ Agent đầu tiên của bạn
Sau khi CLI và Skills được cài đặt, cách dễ nhất để bắt đầu là giao cho Agent của bạn một tác vụ API nhỏ, rủi ro thấp. Ví dụ, yêu cầu nó tạo một endpoint kiểm tra sức khỏe đơn giản trong một dự án Apidog, sau đó đọc lại để xác nhận kết quả.
Sao chép lời nhắc này 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.Điều này cung cấp cho người dùng mới một điểm khởi đầu cụ thể: Agent kiểm tra thiết lập, hỏi trước khi ghi vào một dự án, tạo một định nghĩa API nhỏ và xác nhận kết quả đã lưu.
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 không gian làm việc.
- Tìm hiểu thêm về Apidog CLI để kiểm thử API dòng lệnh, tự động hóa CI và quy trình làm việc của AI Agent.
Câu hỏi thường gặp
Apidog CLI là gì?
Apidog CLI là một công cụ dòng lệnh để chạy các bài kiểm thử API, làm việc với các tài nguyên dự án Apidog và kết nối các tài sản API và kiểm thử của Apidog với các quy trình làm việc tự động hóa.
Apidog CLI có thể chạy các bài kiểm thử API trong CI không?
Có. Các nhóm có thể sử dụng apidog run trong các pipeline CI để chạy các bài kiểm thử API, tạo báo cáo và duy trì các cổng chất lượng tự động trong quy trình làm việc kiểm thử của họ.
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 các thay đổi, ghi chúng vào Apidog, đọc lại kết quả và chạy các bài kiểm thử để xác minh.
cli-schema trong Apidog CLI là gì?
cli-schema giúp xác thực các tệp JSON phức tạp trước khi chúng được ghi vào Apidog. Điều này giúp giảm các 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 các Agent tạo hoặc cập nhật các trường hợp kiểm thử và kịch bản kiểm thử.
Làm cách nào để cài đặt Apidog CLI?
Bạn có thể yêu cầu một AI Agent làm theo hướng dẫn cài đặt Apidog CLI và cài đặt cả CLI và các Skills đi kèm, hoặc cài đặt thủ công bằng npm install -g apidog-cli@latest.