Trong một nhánh sprint mới được tạo, theo mặc định sẽ không có nội dung. Cách tiếp cận này giúp nhà phát triển tập trung vào các thay đổi cần thiết cho sprint hiện tại. Bạn có thể thêm tài nguyên và thực hiện sửa đổi bằng hai phương pháp chính.Chọn cách tiếp cận#
| Phương pháp | Phù hợp nhất cho | Lợi ích chính |
|---|
| Thay đổi thủ công | Phát triển API-First | Đặc tả r õ ràng trước khi phát triển |
| Nhập OAS | Phát triển Code-First | Tự động so sánh với nhánh chính |
Apidog đặc biệt khuyến nghị cách tiếp cận API-First (thay đổi thủ công) để tăng hiệu quả và giảm chi phí cộng tác.
Thay đổi thủ công#
Việc sửa đổi nội dung thủ công trong một nhánh sprint cho phép bạn xác định rõ ràng các đặc tả API trước khi bắt đầu phát triển.Fork tài nguyên từ nhánh chính#
Khi bạn cần sửa đổi các endpoint, schema hoặc thành phần phản hồi hiện có dựa trên yêu cầu của sprint hiện tại:1.
Sử dụng Fork from main để tạo bản sao của các tài nguyên cần thiết
2.
Tất cả thư mục cha sẽ được nhập tự động
3.
Các tài nguyên đã nhập được đánh dấu bằng chỉ báo liên kết
Kéo các thay đổi mới nhất từ nhánh chính#
Trong khi làm việc trong một nhánh sprint, các cập nhật khẩn cấp có thể yêu cầu thay đổi trực tiếp trong nhánh chính. Để đồng bộ hóa:1.
Bạn sẽ nhận được thông báo khi các tài nguyên liên kết trong nhánh chính được cập nhật
2.
Nhấp vào thông báo để xem lại các thay đổi
3.
Chọn kéo các cập nhật hoặc giữ lại nội dung hiện tại của nhánh sprint
4.
Chọn nội dung mong muốn và xác nhận cập nhật
Tạo tài nguyên mới#
Để tạo endpoint, schema hoặc thành phần phản hồi mới cho sprint hiện tại:1.
Sử dụng tính năng New để thêm tài nguyên vào nhánh sprint hiện tại
2.
Nếu thư mục cha cần thiết không tồn tại, hãy sử dụng:Select Endpoint Folders: Chọn các thư mục hiện có
New Endpoint Folder: Tạo thư mục mới
Sắp xếp lại và điều chỉnh nội dung thư mục#
Bạn có thể thực hiện các thao tác tương tự trên tài nguyên đã nhập hoặc mới tạo như trong nhánh chính:Thư mục đã nhập có chỉ báo:Điều chỉnh nội dung thư mục:Xóa và khôi phục tài nguyên#
Các nhánh sprint có tính năng thùng rác hoạt động giống như nhánh chính:2.
Xem tài nguyên đã xóa trong Trash
3.
Khôi phục tài nguyên khi cần
Việc nhập, xóa và khôi phục lặp lại cùng một tài nguyên của nhánh chính có thể dẫn đến các vấn đề dữ liệu không mong muốn. Hãy hạn chế các thao tác này để duy trì tính toàn vẹn dữ liệu.
Mock, so sánh và cộng tác#
Các endpoint trong một nhánh sprint có địa chỉ mock duy nhất dành riêng cho nhánh đó, hoàn toàn dựa trên định nghĩa endpoint của nhánh sprint hiện tại.So sánh tài nguyên của nhánh sprint với các tài nguyên tương ứng trong nhánh chính để xác định những khác biệt cụ thể.Chia sẻ endpoint của nhánh sprint qua liên kết cộng tác với các thành viên khác trong dự án.Khi nhấp vào liên kết cộng tác của endpoint trong nhánh sprint trong khi đang ở một nhánh khác, hệ thống sẽ nhắc bạn chuyển nhánh. Hãy lưu mọi thay đổi trong nhánh hiện tại trước khi chuyển.
Nhập OAS#
Nhập tệp OpenAPI Specification (OAS) trực tiếp vào một nhánh sprint bằng phương pháp nhập thủ công, theo lịch hoặc qua API.Nhập OAS vào nhánh sprint#
1.
Đảm bảo nhánh mục tiêu đã được chọn ở góc trên bên trái
2.
Điều hướng đến Project Settings → Import Data
3.
Nhập dữ liệu vào nhánh hiện tại
Tự động so sánh với nhánh chính#
Khi nhập OAS vào nhánh sprint, logic xử lý như sau:1.
So sánh "Path & Method" của từng endpoint trong tệp OAS với nhánh chính
2.
Nếu giống hệt: Endpoint sẽ không được nhập
3.
Nếu khác: Endpoint được liên kết với nhánh chính và được nhập
4.
Nếu mới: Endpoint mới được tạo trong nhánh sprint
1.
So sánh tên schema trong tệp OAS với nhánh chính
2.
Nếu giống hệt: Schema sẽ không được nhập
3.
Nếu khác: Schema được liên kết với nhánh chính và được nhập
4.
Nếu mới: Schema mới được tạo trong nhánh sprint
Các tài nguyên hoàn toàn không thay đổi so với nhánh chính sẽ không được đưa vào nhánh sprint sau khi nhập, giúp nhà phát triển tập trung vào những thay đổi cần thiết.
