Nhập theo lịch tự động đồng bộ hóa các đặc tả API của bạn từ các nguồn bên ngoài vào Apidog theo các khoảng thời gian định kỳ. Tính năng này lý tưởng cho các nhóm duy trì đặc tả API trong các hệ thống bên ngoài (như kho lưu trữ Git hoặc endpoint Swagger) nhưng muốn tận dụng các khả năng gỡ lỗi và kiểm thử mạnh mẽ của Apidog mà không cần nhập lại thủ công.Với Nhập theo lịch, bạn có thể:Duy trì một nguồn sự thật duy nhất cho đặc tả API trong hệ thống quản lý phiên bản mà bạn ưu tiên
Tự động đồng bộ hóa các thay đổi theo các khoảng thời gian có thể tùy chỉnh (mỗi 30 phút, hằng giờ, hằng ngày, v.v.)
Nhập từ nhiều nguồn bao gồm GitHub, GitLab, Azure DevOps và URL trực tiếp
Giữ cho nhóm của bạn luôn đồng bộ với các thay đổi API mới nhất mà không cần can thiệp thủ công
Cách cấu hình#
1
Điều hướng đến Cài đặtĐi tới Settings -> Import Data -> Scheduled Import (Bind Data Sources).
2
Tạo nguồn dữ liệuNhấp vào "New" để thêm cấu hình.
3
Cấu hình cài đặtĐiền thông tin chi tiết về nguồn dữ liệu (URL, Tần suất, v.v.). Chuyển đến phần tiếp theo để biết chi tiết về việc liên kết kho lưu trữ git.
4
Lưu và kích hoạtNhấp vào Save. Tác vụ nhập giờ đây sẽ tự động chạy dựa trên cài đặt tần suất của bạn.
Apidog hỗ trợ tạo nhiều nguồn dữ liệu trong một dự án duy nhất, mỗi nguồn đồng bộ hóa và nhập vào các thư mục khác nhau.
Liên kết kho lưu trữ Git#
Apidog hỗ trợ liên kết kho lưu trữ git từ:Để liên kết kho lưu trữ git, hãy thực hiện các bước sau.1
Chọn tùy chọn
Git Repository trong hộp thoại
Bind Data Sources và tạo kết nối kho lưu trữ.
2
Sau khi chọn nền tảng quản lý phiên bản mà bạn ưu tiên, hãy làm theo hướng dẫn để cấp cho Apidog quyền truy cập vào các kho lưu trữ của bạn.
3
Khi bạn được chuyển hướng trở lại Apidog, hãy chọn
Organization và
Repository của bạn, sau đó nhấp vào
Save.
4
Cuối cùng, chọn Branch và tệp OpenAPI Spec, rồi hoàn tất quy trình liên kết.
Tham chiếu cấu hình#
| Cài đặt | Mô tả |
|---|
| Tần suất nh ập | Tần suất Apidog kiểm tra và nhập các bản cập nhật từ nguồn dữ liệu của bạn. Các tùy chọn bao gồm mỗi 30 phút, hằng giờ, hằng ngày hoặc các khoảng thời gian tùy chỉnh. |
| Định dạng nguồn | Định dạng đặc tả của tệp API của bạn. Các định dạng được hỗ trợ: OpenAPI (Swagger), ApiDoc hoặc định dạng gốc Apidog. |
| URL nguồn | Liên kết HTTP(S) trực tiếp đến tệp đặc tả API của bạn. Ví dụ: https://petstore.swagger.io/v2/swagger.json. Phải có thể truy cập công khai hoặc được bảo vệ bằng Basic Auth. |
| Chạy trên | Môi trường thực thi cho tác vụ nhập. Chọn Local Client (chạy khi ứng dụng của bạn đang mở) hoặc Runner (chạy trên máy chủ tự lưu trữ 24/7). |
| Basic auth | Thông tin xác thực tên người dùng và mật khẩu nếu URL nguồn của bạn được bảo vệ bằng HTTP Basic Authentication. Để trống đối với URL công khai. |
Chế độ thực thi#
Các tác vụ nhập theo lịch yêu cầu một môi trường thực thi để chạy lệnh tìm nạp. Chọn chế độ phù hợp nhất với quy trình làm việc của bạn:1. Local Client (Mặc định)#
Tác vụ nhập chạy chỉ khi ứng dụng Apidog trên máy tính của bạn đang mở.Yêu cầu: Bạn phải mở dự án với quyền ghi.
Giới hạn: Nếu bạn đóng ứng dụng hoặc dự án, các bản cập nhật sẽ tạm dừng cho đến khi bạn mở lại.
Mạng: Có thể truy cập URL mạng nội bộ nếu máy tính của bạn có thể truy cập chúng.
Việc mở dự án trong Apidog Web App cũng kích hoạt tác vụ nhập theo lịch. Tuy nhiên, do các hạn chế bảo mật của trình duyệt, Web App có thể không truy cập được các URL mạng nội bộ.
2. Self-hosted Runner#
Tác vụ nhập chạy trên máy chủ nơi bạn đã triển khai Apidog Runner.Lợi ích: Chạy 24/7 bất kể bạn có trực tuyến hay không.
Trường hợp sử dụng: Phù hợp nhất cho các nhóm cần cập nhật nhất quán mà không cần can thiệp thủ công.
Nâng cao: Nhập vào các nhánh sprint#
Bạn có thể nhắm mục tiêu các nhánh sprint cụ thể cho tác vụ nhập của mình. Theo mặc định, dữ liệu được nhập vào Main Branch.