Tổng quan

Bộ tiền xử lý và hậu xử lý là một tính năng quan trọng trong Apidog. Khi gửi một yêu cầu, bạn có thể sử dụng bộ tiền xử lý để kiểm soát động yêu cầu của mình, hoặc sử dụng bộ hậu xử lý để xử lý phản hồi nhận được.

Apidog cung cấp giao diện trực quan, kéo và thả cho các thao tác trước và sau yêu cầu, bổ trợ cho các phương pháp truyền thống dựa trên script. Giao diện trực quan này cho phép bạn cấu hình các thao tác phổ biến mà không cần viết mã, trong khi vẫn hỗ trợ script tùy chỉnh cho các trường hợp sử dụng nâng cao.

Bắt đầu nhanh

Dưới đây là các bước để sử dụng bộ tiền xử lý và hậu xử lý trong Apidog:

Mở bất kỳ endpoint nào và điều hướng đến tab Run (Chế độ Design-first) hoặc tab Request (Chế độ Request-first).

Chế độ Design-first

Chế độ Request-first

Chuyển sang mục Pre Processors hoặc Post Processors, di chuột qua + Add, và chọn bộ xử lý mong muốn.

Điền các trường cần thiết cho bộ xử lý đã thêm.

Nhấp vào Send, và yêu cầu sẽ được thực thi với các bộ tiền/hậu xử lý đã cấu hình.

Trong Chế độ Design-first, nhấp vào Save as case để lưu yêu cầu. Trong Chế độ Request-first, nhấp vào Save hoặc Save as case để lưu yêu cầu.

Chế độ Design-first

Chế độ Request-first

TIP

Bạn cũng có thể tạo một yêu cầu độc lập và áp dụng bộ tiền/hậu xử lý cho yêu cầu đó. Tuy nhiên, chúng tôi khuyến nghị tận dụng bộ tiền/hậu xử lý trên đặc tả endpoint để giúp việc gỡ lỗi và kiểm thử được tinh gọn hơn.

Khả năng

Bộ tiền xử lý và hậu xử lý có thể cùng nhau đạt được nhiều chức năng khác nhau:

Bộ tiền xử lý

Thiết lập tham số yêu cầu: Định nghĩa động dữ liệu đầu vào cho endpoint API.

Cấu hình header: Chỉ định các header như Content-Type, Accept, và Authorization.

Xác thực: Thêm token, khóa API hoặc thông tin xác thực cho các endpoint được bảo vệ.

Tích hợp cơ sở dữ liệu: Truy xuất giá trị từ cơ sở dữ liệu để sử dụng làm tham số yêu cầu.

Mã hóa: Bảo mật payload của yêu cầu trước khi truyền.

Bộ hậu xử lý

Khẳng định: Xác thực phản hồi nhận được so với kết quả mong đợi (mã trạng thái, nội dung body, v.v.).

Trích xuất biến: Trích xuất giá trị từ phản hồi để sử dụng trong các yêu cầu tiếp theo.

Thao tác cơ sở dữ liệu: Ghi dữ liệu phản hồi vào cơ sở dữ liệu để lưu trữ hoặc cập nhật.

Trực quan hóa dữ liệu: Tạo báo cáo hoặc biểu diễn trực quan cho dữ liệu phản hồi.

TIP

Một số thao tác trước và sau có thể kích hoạt lời nhắc ủy quyền bảo mật khi truy cập cơ sở dữ liệu, gọi chương trình bên ngoài hoặc tải động các gói npm. Bạn có thể điều hướng đến phần cài đặt Security để cấu hình trước phạm vi của các ủy quyền này.

Các bộ xử lý có sẵn

Apidog hỗ trợ các bộ tiền/hậu xử lý sau:

Bộ xử lý	Loại	Mô tả
Assertion	Post	Định nghĩa các quy tắc xác thực để kiểm tra dữ liệu phản hồi so với giá trị mong đợi (mã trạng thái, body, header).
Extract Variable	Post	Trích xuất giá trị từ phản hồi (JSON, XML, Text) và lưu trữ chúng dưới dạng biến bằng JSONPath hoặc XPath.
Database Operation	Pre/Post	Kết nối đến cơ sở dữ liệu SQL/NoSQL để thực thi truy vấn. Kết quả có thể được lưu trữ dưới dạng biến.
Custom Scripts	Pre/Post	Viết mã JavaScript tùy chỉnh để xử lý logic phức tạp. Truy cập dữ liệu yêu cầu/phản hồi và biến môi trường.
Public Scripts	Pre/Post	Tạo các đoạn script có thể tái sử dụng, được chia sẻ trên nhiều bộ xử lý hoặc kịch bản.
Wait	Pre/Post	Thêm độ trễ trước hoặc sau một yêu cầu, hữu ích để mô phỏng độ trễ trong thế giới thực.

Chúng tôi khuyến nghị sử dụng Apidog Script Generator để đơn giản hóa việc viết script. Mô tả logic của bạn bằng ngôn ngữ tự nhiên, và trình tạo sẽ tạo một script có thể chạy cho bạn.

Thứ tự thực thi

Bộ tiền xử lý và hậu xử lý có thể được cấu hình ở nhiều cấp độ:

Cấp Run/Endpoint Case (Mặc định): Chỉ ảnh hưởng đến lần chạy/case hiện tại.

Cấp Endpoint: Áp dụng cho tất cả các case liên kết với endpoint.

Cấp thư mục: Tác động đến tất cả endpoint trong thư mục.

Cấp dự án: Áp dụng cho tất cả yêu cầu trong dự án (phạm vi cao nhất).

Luồng thực thi đi từ cấp cao nhất (Dự án/Thư mục) xuống đến cấp Run/Case cụ thể.

Trực quan hóa thực thi

Một tập hợp bộ tiền xử lý trong một yêu cầu có thể trông như sau:

Trong ảnh chụp màn hình ở trên:

Ba bộ xử lý đầu tiên được nhóm dưới Inherit from parent. Chúng được định nghĩa trong thư mục Root, các thư mục cụ thể (ví dụ: "Pets"), hoặc chính endpoint.

Các bộ xử lý được kế thừa này ở chế độ chỉ đọc trong lần chạy hiện tại nhưng có thể được bật/tắt.

Bộ xử lý cuối cùng là một script tùy chỉnh được thêm riêng cho lần chạy này và có thể được chỉnh sửa trực tiếp.

Thay thế biến

Bạn có thể nhận thấy một bước có tên Variable Substitution & Inherit from Parents. Bộ tiền xử lý đặc biệt này thay thế các placeholder như {{variable}} bằng giá trị thực tế của chúng.

Hành vi mặc định: Hầu hết bộ tiền xử lý thực thi trước khi thay thế biến.

Sau thay thế: Một số script (ví dụ: ký API) phải chạy sau khi các biến được thay thế. Bạn có thể kéo thủ công các bộ xử lý này xuống bên dưới bước "Variable Substitution".

Luồng thực thi đầy đủ

Thứ tự thực thi chi tiết cho một yêu cầu đơn lẻ như sau:

Bắt đầu nhanh#

Khả năng#

Bộ tiền xử lý#

Bộ hậu xử lý#

Các bộ xử lý có sẵn#

Thứ tự thực thi#

Trực quan hóa thực thi#

Thay thế biến#

Luồng thực thi đầy đủ#