Overview
Advanced Endpoint là loại endpoint phức tạp hơn, hỗ trợ các luồng xử lý logic nội bộ, tương tác với nhiều nguồn dữ liệu hoặc các bước xác thực – xử lý trước khi phản hồi.
Đặc điểm:
- Có thể liên kết với nhiều schemas (input/output).
- Có thể tích hợp với flow xử lý nghiệp vụ (flowchart).
- Dùng trong các nghiệp vụ yêu cầu tính logic cao: xác minh OTP, xử lý giao dịch nhiều bước, gọi API phụ trợ.
Phần này hướng dẫn cách quản lý advanced endpoint trong LLQ Service Visualization:
Tạo mới một Advanced Endpoint
Bước 1: Trên màn hình Project nhấn vào biểu tượng add tại chức năng Endpoint trên thanh công cụ
Bước 2: Màn hình hiển thị form New endpoint, tại Configuration mode chọn chế độ *Advanced, thực hiện nhập đầy đủ các trường thông tin yêu cầu.
Mô tả các trường thông tin:
| Tên trường | Bắt buộc | Định dạng | Ràng buộc | Mô tả |
|---|---|---|---|---|
| Endpoint name | Có | Textbox | Endpoint name phải là duy nhất | Tên của endpoint |
| Description | Không | Textarea | Thông tin mô tả Endpoint |
Variable
Khi xây dựng hoặc chỉnh sửa tài liệu của một Endpoint nâng cao (Advanced Endpoint), nhà phát triển thường cần khai báo lặp đi lặp lại cùng một bộ tham số (như tên biến, mô tả, kiểu dữ liệu) cho cả yêu cầu (request) và phản hồi (response).Việc nhập thủ công nhiều lần không chỉ tốn thời gian mà còn dễ dẫn đến sai sót.
Để tối ưu quy trình này, LLQ Service Visualization cung cấp tính năng Variable, cho phép:
- Khai báo trước các biến đầu vào và đầu ra (input/output).
- Tái sử dụng các biến này trong nhiều endpoint khác nhau.
- Giảm thiểu lỗi nhập liệu và tăng hiệu quả khi thiết kế API.
Variable trong advanced endpoint
Scenario
Trong các hệ thống phức tạp, một Endpoint thường trải qua nhiều bước xử lý để tạo ra kết quả cuối cùng. Điều này đôi khi khiến nhà phát triển khó hình dung rõ luồng hoạt động, đặc biệt nếu chỉ dựa trên mã nguồn hoặc mô tả văn bản.
LLQ Service Visualization thiết kế tính năng Scenario nhằm mục đích:
- Trực quan hóa luồng xử lý của Endpoint, giúp dễ theo dõi và giao tiếp giữa các thành viên trong nhóm.
- Hiểu luồng kỹ thuật và dữ liệu một cách trực quan, không cần đọc mã nguồn chi tiết.
- Phát hiện sớm lỗi hoặc thiết kế chưa tối ưu, như bước dư thừa, thiếu kiểm tra, luồng logic sai...
- Tối ưu hóa và chuẩn hóa thiết kế Endpoint trước khi triển khai chính thức.
Tính năng này đặc biệt hữu ích trong:
- Phân tích nghiệp vụ
- Kiểm thử (test case generation)
- Tài liệu hóa API nâng cao