Khi thực hiện các yêu cầu API, thường cần chuyển đổi giữa các môi trường phát triển, kiểm thử và sản xuất. Apidog giúp việc gửi yêu cầu đến các môi trường khác nhau trở nên thuận tiện—bạn chỉ cần nhấp và chọn môi trường mong muốn ở góc trên bên phải của giao diện.Một môi trường Apidog bao gồm hai thành phần cốt lõi:1.
Base URL: Duy trì đích gửi yêu cầu.
2.
Biến: Các nhóm biến có thể được tham chiếu trong yêu cầu hoặc script.
Tạo môi trường#
1
Mở Quản lý môi trườngNhấp vào nút Quản lý môi trường ≡ ở góc trên bên phải của giao diện.
2
Tạo môi trường mớiNhấp vào mục cuối cùng trong danh sách bên trái có nhãn Môi trường mới.
3
Cấu hình môi trườngNhập tên cho môi trường mới của bạn. Thêm Base URL và các biến. 5
Chọn môi trườngĐể sử dụng môi trường mới, hãy chọn môi trường đó từ bộ chọn môi trường ở góc trên bên phải của giao diện. Thao tác này đặt môi trường đó làm môi trường đang hoạt động và thiết lập tất cả biến thành các giá trị được chỉ định trong môi trường.
Apidog duy trì sự tách biệt rõ ràng giữa môi trường và Base URL. Môi trường đại diện cho các giai đoạn triển khai khác nhau (phát triển, kiểm thử, sản xuất), trong khi Base URL được cấu hình trong từng môi trường. Sự tách biệt này mang lại tính linh hoạt khi quản lý nhiều dịch vụ hoặc micro-service trên các môi trường khác nhau.Ngược lại, môi trường của Apidog phản ánh trực tiếp các môi trường thực như phát triển, kiểm thử và sản xuất, thay vì coi mỗi Base URL là một môi trường riêng lẻ.
Base URL#
Base URL là tính năng chính trong một môi trường Apidog. Trong Apidog, đường dẫn endpoint thường bắt đầu bằng dấu gạch chéo (/) và không bao gồm Base URL. Khi gửi một yêu cầu, Apidog sẽ thêm Base URL đích vào trước đường dẫn endpoint.Định dạng Base URL tiêu chuẩn bắt đầu bằng giao thức và không bao gồm dấu gạch chéo (/) ở cuối.Mỗi Base URL tương ứng với một Module cụ thể. Trong hầu hết trường hợp, một endpoint sẽ sử dụng Base URL của module của nó để gửi yêu cầu.Ví dụ, nếu Base URL của module mặc định cho môi trường Production là http://abc.com/v1 và đường dẫn endpoint của bạn là /pet, thì khi bạn gửi yêu cầu trong môi trường Production, URL yêu cầu thực tế được gửi sẽ là:Nếu đường dẫn endpoint bắt đầu bằng http:// hoặc https://, Base URL sẽ không được thêm vào. Tuy nhiên, nhìn chung không khuyến khích hardcode URL đầy đủ trong endpoint.
Trong Apidog, có một biến môi trường đặc biệt gọi là BASE_URL, lưu trữ Base URL cho "Default Server" của môi trường hiện tại. Nhìn chung không khuyến khích sử dụng trực tiếp biến này.Đối với script tùy chỉnh:Khuyến nghị: Sử dụng pm.request.getBaseUrl() để lấy Base URL cho endpoint hiện tại.
Tránh: Sử dụng pm.environment.get('BASE_URL'), vì phương thức này có thể không lấy đúng Base URL nếu endpoint không thuộc "Default Server".
BASE_URL, biến đó sẽ ghi đè BASE_URL được hệ thống định nghĩa sẵn.Lưu ý: Script không thể sửa đổi chính cấu hình Base URL. Lệnh pm.environment.set('BASE_URL', 'My_url') sẽ chỉ tạo một biến có tên BASE_URL. Sử dụng nhiều Base URL với Module#
Nếu các endpoint trong dự án của bạn cần kết nối đến nhiều Base URL (ví dụ: microservices), cách tốt nhất để quản lý chúng là sử dụng nhiều Module trong Apidog.Endpoint người dùng: https://user.example.com
Endpoint đơn hàng: https://order.example.com
Endpoint sản phẩm: https://product.example.com
1
Tạo ModuleỞ đầu cây thư mục API, thêm nhiều module tương ứng với các dịch vụ của bạn. 2
Cấu hình Base URLTrong Quản lý môi trường, bạn sẽ thấy các trường để thiết lập Base URL cho từng module. Nhập URL cho từng môi trường và nhấp Lưu. 3
Thiết lập Base URL của ModuleTrong phần cài đặt thư mục gốc của một module, chọn Base URL mà các endpoint của module đó nên sử dụng.Cài đặt mặc định: Sử dụng Base URL đầu tiên được liệt kê cho module đó (Khuyến nghị).
Chỉ định thủ công: Chọn một Base URL khác theo cách thủ công. (Không khuyến nghị cho hầu hết trường hợp).
4
Kế thừaTrong các thư mục con hoặc endpoint riêng lẻ, bạn cũng có thể chỉ định Base URL.Kế thừa từ cha: Tuân theo thư mục cha (Mặc định).
Chỉ định thủ công: Ghi đè cho các mục cụ thể.
5
Gửi yêu cầuSau khi thiết lập xong, chỉ cần nhấp Gửi. Apidog xác định Base URL phù hợp dựa trên cài đặt module và môi trường.
Thêm biến môi trường#
Khi bạn thêm một biến vào môi trường, bạn có thể chỉ định hai giá trị:Giá trị ban đầu: Được chia sẻ với nhóm.
Giá trị hiện tại: Được lưu trữ cục bộ trên máy của bạn.
Chuyển đổi giữa các môi trường#
Apidog hiển thị môi trường hi ện tại trong bộ chọn môi trường ở góc trên bên phải của workbench. Mỗi khi bạn thực hiện yêu cầu hoặc thực thi script, Apidog sẽ sử dụng các giá trị hiện tại cho tất cả biến trong môi trường đã chọn.Để chuyển đổi, chỉ cần chọn một môi trường khác từ bộ chọn.Endpoint: Đặc tả API (đường dẫn thường bắt đầu bằng /).
Yêu cầu: Yêu cầu HTTP thực tế được gửi (bao gồm URL đầy đủ).
{{Base_url}} nếu cần.Di chuyển môi trường#
Trong Apidog, Giá trị ban đầu của biến được đồng bộ hóa trong nhóm, trong khi Giá trị hiện tại chỉ được lưu trữ cục bộ. Điều này có nghĩa là các giá trị hiện tại không được chuyển sang các thiết bị khác.Apidog cung cấp chức năng xuất/nhập để di chuyển môi trường (bao gồm các giá trị hiện tại cục bộ) giữa các máy.1
XuấtTrong Quản lý môi trường, di chuột qua ... bên cạnh môi trường, nhấp Xuất để nhận tệp JSON. 2
NhậpTrên máy tính đích, mở Quản lý môi trường, di chuột qua ..., nhấp Nhập, và chọn tệp JSON.
Phạm vi hiển thị của môi trường#
Bạn có thể tạo Môi trường riêng tư cho các biến mà bạn không muốn chia sẻ.Ở góc trên bên phải của phần cài đặt môi trường, thiết lập phạm vi hiển thị.Chia sẻ: Hiển thị với nhóm (Mặc định).
Riêng tư: Chỉ hiển thị với bạn.
Môi trường riêng tư chia sẻ cùng danh sách Dịch vụ (Base URL) với các môi trường khác. Việc thêm hoặc xóa dịch vụ trong một Môi trường riêng tư sẽ ảnh hưởng đồng thời đến tất cả môi trường.
Câu hỏi thường gặp#
Làm thế nào để lấy Base URL của dịch vụ trong script tùy chỉnh?Sử dụng pm.request.getBaseUrl() để truy xuất Base URL của endpoint hiện tại. 
