Hiện tại, hầu hết các API được phân biệt dựa trên method và path. Tuy nhiên, một số dự án phát triển (chẳng hạn như một số tài liệu API thương mại điện tử) sử dụng một URL cố định cho yêu cầu API và phân biệt các API bằng các tham số trong Query / Header.Sau phiên bản 2.2.9, Apidog đã bổ sung tính năng nhận dạng duy nhất endpoint, hỗ trợ OperationId, tham số Query, tham số Body và tham số Header làm các tham số để phân biệt giữa các API.
ID duy nhất của endpoint được định nghĩa ở cấp thư mục. Khi bạn cần đặt một API làm nhận dạng duy nhất, bạn cần thiết lập trong thư mục cha của API đó. Nhấp vào thư mục và chọn tham số nhận dạng duy nhất theo nhu cầu của bạn; sau khi nhấp lưu, thiết lập sẽ có hiệu lực đối với tất cả API trong thư mục đó.
Trong ví dụ này, chúng ta sẽ chọn tham số Query và viết OperationID trong tên tham số.
Sau khi thiết lập nhận dạng duy nhất endpoint cho thư mục, hãy nhấp vào một API trong thư mục đó, nhấp vào tab operationid, và trong cả thông tin cơ bản lẫn các tham số yêu cầu ở phía dưới API, sẽ có biểu tượng K, biểu thị tham số cho ID duy nhất của endpoint.
Bạn có thể nhập giá trị tương ứng dưới tham số tương ứng làm giá trị cho nhận dạng duy nhất endpoint.
Nếu bạn sử dụng các tham số trong Query/Header để phân biệt giữa các API trong dự án và nhập tệp định dạng OpenAPI vào Apidog, trang sau sẽ xuất hiện.Quy tắc khớp API trong quá trình nhập phụ thuộc vào thiết lập của thư mục đích. Nếu thiết lập nhận dạng duy nhất endpoint trong thư mục đích không đáp ứng yêu cầu, bạn có thể sửa đổi trong phần cài đặt nhập. Sau khi sửa đổi, thiết lập sẽ có hiệu lực trực tiếp đối với thư mục đích.Ví dụ, chúng ta sẽ nhập thư mục này và tạo ID duy nhất endpoint cho thư mục đó bằng Query Param và Param Name được gọi là action.
Hãy nhớ rằng, nếu thư mục của bạn đã có ID duy nhất, lần nhập mới không thể ghi đè ID đó.
Lưu ý quan trọng
1.
Người dùng đã sử dụng Fixed Value trong tham số Query không cần lo lắng vì chức năng này vẫn sẽ được giữ lại. Tuy nhiên, khi nhập, Fixed Value được đánh giá dựa trên URL, vì vậy khuyến nghị người dùng đã sử dụng Fixed Value nên sử dụng nhận dạng duy nhất endpoint.
2.
Nhận dạng duy nhất endpoint hỗ trợ thiết lập nhiều tham số.
3.
Nếu chỉ một thư mục con trong thư mục của bạn được đặt làm nhận dạng duy nhất endpoint, khi nhập Swagger và cập nhật tất cả thư mục, vui lòng tránh nhập toàn bộ dự án vào thư mục gốc để cập nhật. Khuyến nghị nhập riêng các API được đặt làm nhận dạng duy nhất endpoint vào thư mục đặc biệt đó.
Bắt đầu từ phiên bản 2.2.24, nếu API đã đặt mã định danh duy nhất là Body Parameter hoặc Header Parameter, bạn cần gửi path + tên tham số và giá trị của mã định danh duy nhất để nhận Mock Data tương ứng.
Thực tiễn tốt nhất về Mock Data
1.
Khi truy cập Mock Data trong quá trình phát triển, các lập trình viên frontend cũng cần gửi path + tên tham số và giá trị của mã định danh duy nhất nếu API đã đặt mã định danh duy nhất là Body Parameter hoặc Header Parameter.
2.
Đối với các dự án có mã định danh duy nhất cho API, tài liệu API cần được chuẩn hóa để tránh các trường hợp API có cùng URL nhưng không được đặt mã định danh duy nhất. Điều này nhằm tránh việc không thể lấy Mock Data chính xác.
