Đây là một loạt bài gồm 10 phần chia sẻ cách Apidog đã phát triển Apidog CLI, một công cụ dòng lệnh để kiểm thử API và quản lý vòng đời API. Bạn có thể đọc theo thứ tự hoặc chuyển đến bất kỳ bài viết nào bạn quan tâm:
| Tiêu đề | Trọng tâm | |
|---|---|---|
| 1 | Chúng tôi đã xây dựng 126 Công cụ MCP. Nhưng đó không phải là Giải pháp tốt nhất cho Agent | Khám phá vấn đề |
| 2 | Tại sao chúng tôi phát triển Apidog CLI hoàn toàn mới | Phát triển kiến trúc |
| 3 | Quy tắc vàng: CLI tạo ra dữ kiện, Mô hình hoạt động dựa trên dữ kiện | Triết lý cốt lõi |
| 4 | agentHints: Dạy CLI giao tiếp với Agent |
Đầu ra có cấu trúc |
| 5 | SKILL: Chuyển giao kinh nghiệm vận hành dưới dạng mã | Kinh nghiệm vận hành |
| 6 | Các con số không biết nói dối: Giảm 30% số lần gọi công cụ, giảm 25% số Token | Kết quả định lượng |
| 7 | Từ PRD đến vòng lặp kiểm thử: Quy trình làm việc hoàn chỉnh của Agent với Apidog CLI | Hướng dẫn thực hành |
| 8 | Tại sao khả năng tương thích CI/CD là không thể thiếu đối với các công cụ Agent | Góc nhìn DevOps |
| 9 | Nhánh AI: Thay đổi dự án an toàn hơn với AI Agent | Lớp bảo mật |
| 10 | Ưu tiên đặc tả đã là quá khứ. Chào mừng đến với Ưu tiên kỹ năng. | Tầm nhìn & tương lai |
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à rất quan trọng. Nhánh AI cung cấp một môi trường chỉnh sửa biệt lập—các thay đổi chỉ được đưa vào nhánh mục tiêu sau khi có xác nhận của con người.
Thử thách bảo mật
Khi AI Agent tham gia vào quá trình phát triển và kiểm thử API, chúng có thể tạo, cập nhật và xóa tài nguyên dự án thông qua các lệnh CLI.
Quyền năng này đi kèm với rủi ro.
| Rủi ro | Điều gì có thể xảy ra |
|---|---|
| Đầu ra không thể đoán trước | Agent ghi nội dung không mong muốn |
| Lỗi trường | Xác nhận sai, thiếu tham số |
| Mở rộng phạm vi | Agent sửa đổi tài nguyên ngoài nhiệm vụ |
| Không có dấu vết xem xét | Các thay đổi xuất hiện trực tiếp trong nhánh chính |
| Gián đoạn nhóm | Nhánh cộng tác dùng chung đột ngột thay đổi |
Làm thế nào để bạn cho phép Agent làm việc trên các dự án thực mà không gây rủi ro cho nhánh chính?
Nhánh AI: Lớp an toàn
Nhánh AI là một loại Nhánh Sprint đặc biệt được thiết kế dành riêng cho các hoạt động AI và CLI bên ngoài.

Khái niệm chính:
Tất cả các thao tác chỉnh sửa được khởi tạo từ Apidog CLI đều được coi là do AI / AI Agent khởi tạo theo mặc định.
Nhánh AI cung cấp cho AI Agent một nhánh chỉnh sửa biệt lập. Các thay đổi sẽ nằm trong Nhánh AI cho đến khi có người xem xét và hợp nhất chúng.
Agent thực hiện thay đổi qua CLI
↓
Các thay đổi được lưu trữ trong Nhánh AI (biệt lập)
↓
Người dùng xem xét sự khác biệt
↓
Người dùng xác nhận phạm vi tài nguyên
↓
Hợp nhất vào nhánh mục tiêu (trực tiếp hoặc yêu cầu hợp nhất)Nhánh chính vẫn không bị ảnh hưởng cho đến khi bạn phê duyệt.
Tại sao cần Nhánh AI
Các chỉnh sửa do AI khởi tạo có thể không thể đoán trước. Apidog CLI cung cấp nhiều khả năng chỉnh sửa—điểm cuối, lược đồ, kịch bản kiểm thử, bộ kiểm thử, v.v.
Nhánh AI được thiết kế cho các thao tác chỉnh sửa do AI khởi tạo có rủi ro cao này.
Nó cho phép AI Agent chỉnh sửa tài nguyên dự án trong một phạm vi kiểm soát:
| Không có Nhánh AI | Với Nhánh AI |
|---|---|
| Agent ghi trực tiếp vào nhánh chính | Agent ghi vào nhánh biệt lập |
| Các thay đổi xuất hiện ngay lập tức | Các thay đổi chờ được xem xét |
| Không có lưới an toàn | Cần xác nhận của con người |
| Rủi ro sửa đổi ngoài ý muốn | Phạm vi giới hạn ở các tài nguyên cụ thể |
Nhánh AI là gì?
Nhánh AI là một nhánh sprint đặc biệt với các đặc điểm cụ thể:
Đặc điểm chính
| Đặc điểm | Mô tả |
|---|---|
| Chỉnh sửa biệt lập | Các thay đổi được lưu trữ trong Nhánh AI, không ảnh hưởng đến nhánh chính hoặc nhánh nguồn |
| Nguồn rõ ràng | Không thể tạo trong client—phải đến từ CLI/MCP; ghi lại nhánh nguồn |
| Xác nhận của con người | Các thay đổi phải được xác nhận trước khi hợp nhất |
| Không giới hạn số lượng | Tạo bao nhiêu Nhánh AI tùy thích cho các tác vụ khác nhau |
| Lưu trữ tự động | Các nhánh không có sự khác biệt được lưu trữ sau mỗi 24 giờ |
Cách hoạt động
| Thao tác | Nơi diễn ra |
|---|---|
| AI tạo điểm cuối | Trong Nhánh AI |
| AI cập nhật kịch bản kiểm thử | Trong Nhánh AI |
| Nhóm xem xét thay đổi | Trong client hoặc xem trước CLI |
| Người dùng phê duyệt hợp nhất | Hành động của người dùng, không phải của AI |
| Các thay đổi vào nhánh mục tiêu | Sau khi xác nhận |
Việc chỉnh sửa thông thường trong client bởi người dùng vẫn tuân theo quyền của thành viên dự án và các quy tắc bảo vệ nhánh.
Các trường hợp sử dụng
Nhánh AI phù hợp khi AI cần tham gia vào việc bảo trì dự án trong khi vẫn duy trì sự biệt lập của nhánh và xác nhận của con người.
| Kịch bản | Nhánh AI hỗ trợ như thế nào |
|---|---|
| Tạo bản nháp API từ mã | AI tạo các điểm cuối trong Nhánh AI; người dùng xác nhận trước khi hợp nhất |
| Tổ chức tài nguyên API hàng loạt | AI điều chỉnh thư mục, mô tả, mô hình mà không ảnh hưởng đến nhánh cộng tác |
| Tạo bản nháp kiểm thử tự động | AI tạo kịch bản/trường hợp kiểm thử trong Nhánh AI để người kiểm thử xem xét |
| Điền vào các khoảng trống trong tài liệu API | AI bổ sung các trường còn thiếu dựa trên báo cáo lỗi hoặc triển khai |
| Ghi hàng loạt trong CI/CD | Các quy trình làm việc tự động ghi vào Nhánh AI, chờ người dùng hợp nhất |
Quy trình làm việc cơ bản
Một quy trình làm việc điển hình của Nhánh AI:
┌─────────────────────────────────────────────────────────────────┐
│ QUY TRÌNH LÀM VIỆC CỦA NHÁNH AI │
├─────────────────────────────────────────────────────────────────┤
│ │
│ Bước 1: Tạo Nhánh AI │
│ ┌───────────────────────────────────────────┐ │
│ │ apidog branch create --type ai │ │
│ │ --name "ai/20260312-from-main-feature" │ │
│ │ --from main │ │
│ └───────────────────────────────────────────┘ │
│ ↓ │
│ Bước 2: Nhập hoặc Tạo Tài nguyên │
│ ┌───────────────────────────────────────────┐ │
│ │ apidog branch pick-to (nhập tài nguyên hiện có) │ │
│ │ HOẶC │ │
│ │ apidog endpoint create (tạo mới) │ │
│ └───────────────────────────────────────────┘ │
│ ↓ │
│ Bước 3: AI sửa đổi Tài nguyên │
│ ┌───────────────────────────────────────────┐ │
│ │ Agent sử dụng CLI để cập nhật điểm cuối, │ │
│ │ lược đồ, kịch bản kiểm thử, v.v. │ │
│ │ (tham số --branch chỉ định Nhánh AI) │ │
│ └───────────────────────────────────────────┘ │
│ ↓ │
│ Bước 4: Người dùng xem xét sự khác biệt │
│ ┌───────────────────────────────────────────┐ │
│ │ apidog merge-request preview │ │
│ │ HOẶC │ │
│ │ Xem trong client Apidog │ │
│ └───────────────────────────────────────────┘ │
│ ↓ │
│ Bước 5: Hợp nhất vào Nhánh mục tiêu │
│ ┌───────────────────────────────────────────┐ │
│ │ Hợp nhất trực tiếp (nhánh không được bảo vệ) │ │
│ │ HOẶC │ │
│ │ Yêu cầu hợp nhất (nhánh được bảo vệ) │ │
│ └───────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────────┘Tạo một Nhánh AI
Sử dụng branch create --type ai:
apidog branch create \
--project 123456 \
--type ai \
--name "ai/20260312-from-main-userRegister" \
--from mainĐề xuất đặt tên: ai/YYYYMMDD-from-sourceBranch-featureOrModule
| Lệnh | Mục đích |
|---|---|
branch create --type ai |
Tạo Nhánh AI |
branch list --type ai |
Xem các Nhánh AI trong dự án |
branch list --type all |
Xem tất cả các loại nhánh |
branch get --type ai |
Xem chi tiết Nhánh AI |
Chỉnh sửa Tài nguyên trong một Nhánh AI
Khi CLI ghi tài nguyên dự án, hãy sử dụng tham số --branch để ghi vào Nhánh AI:
| Tài nguyên | Ví dụ lệnh |
|---|---|
| Điểm cuối HTTP | apidog endpoint create --project <id> --branch <aiBranchName> --file ./endpoint.json |
| Mô hình dữ liệu | apidog schema update <schemaId> --project <id> --branch <aiBranchName> --file ./schema.json |
| Kịch bản kiểm thử | apidog test-scenario update <scenarioId> --project <id> --branch <aiBranchName> --file ./scenario.json |
| Bộ kiểm thử | apidog test-suite create --project <id> --branch <aiBranchName> --file ./suite.json |
Quy trình làm việc được đề xuất:
# 1. Lấy lược đồ
apidog cli-schema get endpoint-create
# 2. Xác thực trước khi ghi
apidog cli-schema validate endpoint-create --file ./endpoint.json
# 3. Ghi vào Nhánh AI (không phải nhánh chính)
apidog endpoint create \
--project 123456 \
--branch "ai/20260312-from-main-userRegister" \
--file ./endpoint.jsonNhập Tài nguyên hiện có
Để sửa đổi các tài nguyên hiện có, trước tiên hãy nhập chúng từ nhánh nguồn:
apidog branch pick-to \
--project 123456 \
--from main \
--to "ai/20260312-from-main-userRegister" \
--endpoint-ids 1001,1002Điều này đảm bảo AI làm việc với phiên bản cơ sở chính xác.
Xem xét Thay đổi trước khi Hợp nhất
Trước khi hợp nhất, hãy xem trước sự khác biệt:
apidog merge-request preview \
--project 123456 \
--from "ai/20260312-from-main-userRegister" \
--to mainHoặc xem toàn bộ sự khác biệt trong client Apidog.
| Lệnh | Mục đích |
|---|---|
merge-request preview |
Quét các thay đổi ứng cử viên |
branch get --type ai |
Xem thông tin Nhánh AI |
Hợp nhất một Nhánh AI
Sau khi xem xét, hợp nhất các thay đổi:
Hợp nhất trực tiếp (Nhánh không được bảo vệ)
apidog branch merge \
--project 123456 \
--from "ai/20260312-from-main-userRegister" \
--to main \
--endpoint-ids 1001,1002Yêu cầu hợp nhất (Nhánh được bảo vệ)
apidog merge-request create \
--project 123456 \
--from "ai/20260312-from-main-userRegister" \
--to main \
--reviewer-ids 20001,20002 \
--endpoint-ids 1001,1002
| Lệnh | Mục đích |
|---|---|
branch merge |
Hợp nhất trực tiếp vào nhánh không được bảo vệ |
merge-request create |
Tạo yêu cầu hợp nhất để xem xét |
merge-request approve |
Phê duyệt yêu cầu hợp nhất |
merge-request reject |
Từ chối yêu cầu hợp nhất |
Quan trọng: Các lệnh hợp nhất chỉ xử lý danh sách tài nguyên được cung cấp rõ ràng. Xác nhận các phần phụ thuộc (thư mục, mô hình, thành phần phản hồi, kiểm thử) trước khi hợp nhất.
Lưu trữ và Xóa
Sau khi các thay đổi được hợp nhất hoặc không còn cần thiết:
# Lưu trữ
apidog branch archive "ai/20260312-from-main-userRegister" \
--project 123456 --type ai
# Xóa (sau khi lưu trữ)
apidog branch delete "ai/20260312-from-main-userRegister" \
--project 123456 --type aiQuyền chỉnh sửa AI bên ngoài
Theo mặc định, CLI ghi vào Nhánh AI. Điều này giữ cho các thay đổi do AI tạo ra được biệt lập cho đến khi người dùng xác nhận.
Để bật chỉnh sửa trực tiếp nhánh chính:
Project Settings → Feature Settings → AI Feature Settings → External AI Edit Permissions
| Quyền | Nó cho phép gì |
|---|---|
| Chỉnh sửa trực tiếp nhánh chính | CLI ghi trực tiếp vào nhánh chính (bỏ qua Nhánh AI) |
| Chỉnh sửa trực tiếp nhánh sprint tiêu chuẩn | CLI ghi trực tiếp vào các nhánh sprint |
| Chỉnh sửa trực tiếp nhánh chung | CLI ghi trực tiếp vào các nhánh chung |
| Chỉnh sửa trực tiếp Nhánh AI | CLI ghi vào các Nhánh AI (thường được giữ bật) |
Khuyến nghị: Giữ tính năng biệt lập của Nhánh AI được bật. Chỉ bật chỉnh sửa trực tiếp khi quy trình làm việc tự động hóa thực sự cần đến.
Các phương pháp hay nhất
| Phương pháp | Lý do |
|---|---|
| Một Nhánh AI cho mỗi tác vụ | Phạm vi rõ ràng: API đăng ký người dùng, tài liệu module đặt hàng, kiểm thử thanh toán |
| Nhập trước khi chỉnh sửa | Sử dụng pick-to cho các tài nguyên hiện có—tránh nhầm lẫn nguồn |
| Xác thực trước khi ghi | Sử dụng cli-schema validate để phát hiện lỗi trước khi đến Nhánh AI |
| Xem trước trước khi hợp nhất | Sử dụng merge-request preview hoặc xem khác biệt trong client |
| Phạm vi hợp nhất rõ ràng | Xác nhận điểm cuối, mô hình, thư mục, kiểm thử cùng nhau |
| Giữ đánh giá của con người | Định nghĩa API, tập lệnh kiểm thử nên được xem xét trước khi hợp nhất |
| Lưu trữ kịp thời | Giữ danh sách nhánh rõ ràng sau khi hợp nhất hoặc loại bỏ |
Nhánh AI trong Quy trình làm việc CLI + SKILL
Nhánh AI tích hợp tự nhiên với CLI + SKILL:
| Giai đoạn | CLI + SKILL + Nhánh AI |
|---|---|
| Đọc | endpoint get từ bất kỳ nhánh nào |
| Tạo | Agent tạo JSON |
| Xác thực | cli-schema validate cục bộ |
| Ghi | endpoint create --branch <aiBranchName> vào Nhánh AI |
| Xem xét | merge-request preview |
| Hợp nhất | Người dùng xác nhận, sau đó branch merge |
| Xác minh | apidog run trên các tài nguyên đã hợp nhất |
Mọi thao tác ghi đều đi qua Nhánh AI → xem xét của con người → hợp nhất.
Tóm tắt bảo mật
| Lớp | Bảo vệ |
|---|---|
cli-schema validate |
Phát hiện lỗi cấu trúc trước khi ghi |
agentHints |
Hướng dẫn Agent các bước tiếp theo an toàn |
| Nhánh AI | Biệt lập các thay đổi khỏi nhánh chính |
| Xem xét của con người | Xác nhận nội dung trước khi hợp nhất |
| Phạm vi hợp nhất | Người dùng chọn tài nguyên nào để hợp nhất |
Cùng với nhau, các lớp này tạo ra một vòng lặp an toàn hơn cho các thay đổi dự án do Agent điều khiển.
Tiếp theo là gì
Với Nhánh AI cung cấp lớp an toàn, tất cả các mảnh ghép đã ở đúng vị trí:
- MCP để kết nối công cụ (Phần 1)
- CLI + SKILL để thực thi quy trình làm việc (Phần 2-5)
- Kết quả xác thực (Phần 6)
- Các quy trình làm việc thực tế (Phần 7)
- Nền tảng CI/CD (Phần 8)
- Nhánh AI để đảm bảo an toàn (Phần 9)
Bây giờ là lúc cho tầm nhìn.
Trong Phần 10, "Thiết kế theo đặc tả" là chuyện của ngày hôm qua. Chào mừng đến với "Thiết kế theo kỹ năng"., chúng ta sẽ phác thảo cách phát triển API tiến hóa cùng với AI Agent—và những gì các nhóm nên làm tiếp theo.
Những điểm chính
- Nhánh AI cung cấp khả năng chỉnh sửa biệt lập cho các hoạt động AI/CLI
- Các thay đổi không ảnh hưởng đến nhánh chính cho đến khi có xác nhận của con người
- Tạo bằng
branch create --type ai, ghi bằng tham số--branch - Nhập tài nguyên hiện có bằng
branch pick-totrước khi chỉnh sửa - Xem trước bằng
merge-request preview, sau đó hợp nhất hoặc tạo yêu cầu hợp nhất - Quyền chỉnh sửa trực tiếp có thể bỏ qua Nhánh AI—hãy sử dụng cẩn thận
- Thực hành tốt nhất: một Nhánh AI cho mỗi tác vụ, xác thực trước khi ghi, xem xét trước khi hợp nhất
Tải xuống Apidog để thiết kế, giả lập, kiểm thử, và tạo tài liệu 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.
nút
