Mock tùy chỉnh

Apidog cung cấp các tính năng tùy chỉnh mock mạnh mẽ, cho phép bạn kiểm soát chi tiết các phản hồi API. Tài liệu này giới thiệu hai cách tiếp cận để tùy chỉnh dữ liệu mock:

Tùy chỉnh cấp trường: Kiểm soát các trường cụ thể trong khi sử dụng smart mock cho các trường khác

Tùy chỉnh toàn bộ phản hồi: Định nghĩa các phản hồi mock hoàn chỉnh với kỳ vọng (cố định, có điều kiện hoặc động)

Tùy chỉnh cấp trường

Đôi khi bạn cần định nghĩa các giá trị cụ thể cho một số trường nhất định, đồng thời để Apidog tự động tạo phần còn lại. Apidog cung cấp các phương thức linh hoạt để kiểm soát ở cấp trường.

Thiết lập giá trị trường tùy chỉnh

1. Giá trị cố định

Chỉ định một giá trị tĩnh trong trường mock của đặc tả endpoint. Apidog sẽ luôn trả về chính xác giá trị này cho trường đó, đồng thời sử dụng smart mock cho các trường không được chỉ định.

Ví dụ:

2. Giá trị động với Faker.js

Tạo dữ liệu ngẫu nhiên thực tế bằng các giá trị động của Apidog (dựa trên Faker.js). Sử dụng cú pháp:

{{$category.method}}

Ví dụ phổ biến:

Biểu thức	Kết quả ví dụ
`{{$person.fullName}}`	Rachel Wheeler
`{{$internet.email}}`	Arno.Huels33@yahoo.com
`{{$commerce.productName}}`	Elegant Plastic Bike

Chọn giá trị động trực tiếp từ menu thả xuống:

3. Phương thức Faker có tham số

Truyền tham số vào các phương thức giá trị động để tạo dữ liệu chuyên biệt bằng cú pháp Faker.js nâng cao của Apidog.

Ví dụ:

Trường hợp sử dụng	Biểu thức	Mô tả
Khoảng số nguyên	`{{$number.int(min=0,max=10000)}}`	Số nguyên ngẫu nhiên từ 0 đến 10.000
Điện thoại dễ đọc	`{{$phone.number(style='human')}}`	Định dạng điện thoại dễ đọc cho con người
Bội số của N	`{{$number.int(multipleOf=3)}}`	Số nguyên chia hết cho 3
Phần tử mảng	`{{$helpers.arrayElement(['red','blue','green'])}}`	Màu ngẫu nhiên từ mảng
Khoảng ngày	`{{$date.between(from='2024-01-01',to='2024-12-31',format='yyyy-MM-dd')}}`	Ngày nằm trong khoảng đã chỉ định

Khám phá danh sách đầy đủ các module, phương thức và tham số trong tài liệu Dynamic Values Modules.

4. Nối nhiều biểu thức

Kết hợp văn bản tĩnh và nhiều biểu thức động để tạo các giá trị trường phức tạp.

Ví dụ: Tạo địa chỉ đầy đủ

{{$location.streetAddress}}, {{$location.city}}, {{$location.state}}, {{$location.zipCode}}, {{$location.country}}

Đầu ra mẫu:

8507 Hudson Alley, Rochester, Wisconsin, 96512, United States

Mỗi thành phần được tạo động, tạo ra các địa chỉ độc nhất và thực tế cho mỗi lần gọi mock API.

Locale mock

Apidog hỗ trợ các locale mock có thể tùy chỉnh, cho phép bạn tạo dữ liệu kiểm thử động bằng các ngôn ngữ và định dạng khác nhau phù hợp với khu vực hoặc đối tượng mục tiêu của bạn. Để tìm hiểu thêm về cách cấu hình locale mock, hãy truy cập Ngôn ngữ mock (Locales).

Tùy chỉnh toàn bộ phản hồi (Kỳ vọng mock)

Để kiểm soát hoàn toàn các phản hồi mock, hãy sử dụng kỳ vọng mock. Tính năng này cho phép bạn định nghĩa các phản hồi cố định, có điều kiện hoặc động.

Tạo kỳ vọng mock

Phản hồi cố định

Trả về cùng một dữ liệu cho mọi yêu cầu bằng cách tạo một kỳ vọng không điều kiện.

Các bước:

Nhấp vào New expectation

Thêm tên kỳ vọng và để trống các điều kiện

Điền dữ liệu phản hồi mà bạn muốn trả về, sau đó lưu

Sao chép và sử dụng URL mock được cung cấp để truy cập endpoint này

Phản hồi có điều kiện

Trả về dữ liệu mock khác nhau dựa trên các tham số yêu cầu. Mock engine đánh giá các điều kiện từ trên xuống dưới, trả về kỳ vọng khớp đầu tiên.

Các loại điều kiện được hỗ trợ:

Loại tham số	Mô tả
Tham số query	Chuỗi query của URL
Tham số path	Các phân đoạn URL động
Tham số header	HTTP header
Tham số cookie	Giá trị cookie
Tham số body	Trường body JSON (thông qua JSON path)

Hành vi điều kiện

Nhiều điều kiện được kết hợp bằng logic AND (tất cả đều phải khớp)

Nếu không có điều kiện nào khớp, Apidog sẽ quay về mức ưu tiên phương thức Mock trong Project Settings → Feature Settings → Mock Settings

Giới hạn

Tham số body chỉ hỗ trợ JSON, không hỗ trợ XML

Điều kiện tham số không thể sử dụng {{variables}}

Định dạng body của yêu cầu phải khớp với đặc tả API (ví dụ: form-data, JSON)

Điều kiện địa chỉ IP có thể giới hạn phản hồi cho các IP cụ thể

Dữ liệu mock động

Kỳ vọng mock hỗ trợ dữ liệu động, ngẫu nhiên bằng cú pháp mẫu Faker.js và Nunjucks.

Ví dụ:

{
    "data": [
        {% for i in range(0, 20) %}
        {% if i>1 %},{% endif %}
        {
            "id": {{i}},
            "firstname": "{{$person.firstName}}",
            "lastname": "{{$person.lastName}}"
        }
        {% endfor %}
    ],
    "success": true
}

Điều này tạo ra:

Mảng gồm 20 đối tượng người dùng (id từ 0 đến 19)

Mỗi đối tượng có tên và họ được tạo ngẫu nhiên

Một trường hằng "success": true

Ghi chú cú pháp:

Cú pháp	Mục đích
`{{$...}}`	Gọi Faker.js để tạo giá trị ngẫu nhiên
`{% for ... %}`	Cấu trúc vòng lặp Nunjucks
`{{i}}`	Biến vòng lặp Nunjucks (không phải biến Apidog)

Khác biệt quan trọng

Apidog sử dụng {{$person.firstName}} thay vì Faker.js gốc faker.person.firstName()

Biến dự án/môi trường Apidog ({{variable}}) không khả dụng trong kỳ vọng mock

Tham khảo tài liệu Faker.js và Nunjucks để biết cú pháp đầy đủ

Tính năng nâng cao

Header phản hồi tùy chỉnh

Thêm header tùy chỉnh vào kỳ vọng mock để mô phỏng xác thực, phân trang hoặc các hành vi API khác.

Thuộc tính phản hồi nâng cao

Cấu hình các thuộc tính phản hồi bổ sung trong tab More:

Thuộc tính	Mục đích	Mặc định
HTTP Status Code	Mô phỏng lỗi hoặc trường hợp đặc biệt	200
Response Delay	Mô phỏng độ trễ mạng (mili giây)	0

Bật/Tắt kỳ vọng

Bật hoặc tắt từng kỳ vọng một cách độc lập cho các môi trường mock cục bộ và cloud từ danh sách kỳ vọng.

Tóm tắt

Các tính năng mock tùy chỉnh của Apidog cung cấp:

Tùy chỉnh trường linh hoạt với giá trị cố định hoặc động

Kiểm soát toàn bộ phản hồi thông qua kỳ vọng mock

Logic có điều kiện cho các phản hồi dựa trên tham số

Tạo dữ liệu động bằng Faker.js và Nunjucks

Mô phỏng nâng cao với header tùy chỉnh, độ trễ và mã trạng thái

Các tính năng này cho phép bạn tạo các mô phỏng API mạnh mẽ, có độ trung thực cao và phản ánh chính xác hành vi production!

Tùy chỉnh cấp trường#

Thiết lập giá trị trường tùy chỉnh#

1. Giá trị cố định#

2. Giá trị động với Faker.js#

3. Phương thức Faker có tham số#

4. Nối nhiều biểu thức#

Tùy chỉnh toàn bộ phản hồi (Kỳ vọng mock)#

Tạo kỳ vọng mock#

Phản hồi cố định#

Phản hồi có điều kiện#

Dữ liệu mock động#

Tính năng nâng cao#

Header phản hồi tùy chỉnh#

Thuộc tính phản hồi nâng cao#

Bật/Tắt kỳ vọng#

Tóm tắt#

Tùy chỉnh cấp trường

Thiết lập giá trị trường tùy chỉnh

1. Giá trị cố định

2. Giá trị động với Faker.js

3. Phương thức Faker có tham số

4. Nối nhiều biểu thức

Tùy chỉnh toàn bộ phản hồi (Kỳ vọng mock)

Tạo kỳ vọng mock

Phản hồi cố định

Phản hồi có điều kiện

Dữ liệu mock động

Tính năng nâng cao

Header phản hồi tùy chỉnh

Thuộc tính phản hồi nâng cao

Bật/Tắt kỳ vọng

Tóm tắt