Trong một dự án Apidog, bạn có thể sử dụng mô-đun để tổ chức các endpoint của mình. Một mô-đun tương tự như một "dịch vụ" trong kiến trúc kỹ thuật, được thiết kế để giúp bạn quản lý và trình bày endpoint hiệu quả hơn — đặc biệt trong các hệ thống dựa trên microservice. Mỗi mô-đun bao gồm tập hợp endpoint liên quan riêng, các thành phần (chẳng hạn như schema, phản hồi và lược đồ bảo mật), cũng như Base URL (một Base URL cho mỗi môi trường).Mỗi mô-đun tương ứng với một tệp đặc tả Swagger/OpenAPI hoàn chỉnh và độc lập.Khi nào nên sử dụng mô-đun#
Sử dụng mô-đun để tổ chức endpoint của bạn khi:Các dịch vụ có liên quan chặt chẽ: Ví dụ, trong một dự án AI: một mô-đun cho các endpoint tạo văn bản, một mô-đun khác cho các endpoint tạo hình ảnh và một mô-đun cho các endpoint giọng nói.
Microservice: Ví dụ, trong một dự án thương mại điện tử, bạn có thể có các dịch vụ xác thực, đơn hàng và sản phẩm.
Nhiều phiên bản API: Ví dụ, dự án của bạn cung cấp các phiên bản API khác nhau cho người dùng bên ngoài, ch ẳng hạn như Legacy, LTS và Latest.
Tạo mô-đun#
1
Trong dự án, di chuột lên phía trên cùng của cây thư mục và nhấp vào nút
+. Trong menu thả xuống, chọn
New Module.
2
Nhập
tên mô-đun và nhấp vào
Save. Mô-đun mới sẽ xuất hiện trong cây thư mục. Nhấp vào mô-đun để xem chi tiết, bao gồm:
Thống kê dữ liệu của tài nguyên trong mô-đun
Mức độ bao phủ của trường hợp endpoint và kịch bản kiểm thử
Tùy chọn xuất cho các endpoint trong mô-đun
Biến mô-đun – tương tự như biến môi trường, nhưng chỉ có thể truy cập trong các yêu cầu endpoint của mô-đun này. Thiết lập Base URL cho từng mô-đun#
Sau khi một mô-đun được tạo, mô-đun đó sẽ tự động xuất hiện trong trang Quản lý môi trường. Bạn có thể gán một Base URL cho từng môi trường trong mô-đun mới được thêm vào.Sử dụng đúng Base URL khi gửi yêu cầu#
Theo mặc định, các yêu cầu endpoint của mỗi mô-đun sẽ tự động sử dụng Base URL được xác định cho mô-đun đó trong môi trường hiện tại, kết hợp với đường dẫn endpoint. Endpoint từ một mô-đun không thể sử dụng Base URL của mô-đun khác để gửi yêu cầu.Nếu một mô-đun duy nhất chứa nhiều dịch vụ (nhiều Base URL), bạn có thể chỉ định thủ công Base URL nào sẽ được sử dụng ở cấp thư mục hoặc endpoint trong mô-đun.Tuy nhiên, cách tiếp cận này là một phần của mẫu sử dụng cũ hơn trong Apidog và không được khuyến nghị kể từ phiên bản 2.7.16. Thay vào đó, chúng tôi đề xuất tách các dịch vụ thành các mô-đun riêng biệt, mỗi mô-đun có Base URL riêng. Modified at 2026-06-11 10:23:06
