Basic Endpoint
Basic endpoint là một loại endpoint đơn giản, trong đó kết quả phản hồi (response) luôn là cố định, không phụ thuộc vào nội dung request gửi đến. Loại endpoint này được sử dụng phổ biến để mô phỏng hành vi cơ bản của một API khi:
- Cần phản hồi nhanh để frontend/test gọi thử khi backend chưa sẵn sàng.
- Không cần xử lý logic hoặc điều kiện phức tạp.
Tạo mới basic endpoint
Bước 1: Tại màn hình chi tiết REST Project, nhấn vào biểu tượng 
trên thanh menu hoặc nhấn vào biểu tượng 
tại menu Endpoints.
Bước 2: Hệ thống hiển thị màn hình pop up tạo mới endpoint, thực hiện nhập đầy đủ thông tin để tạo mới endpoint.
Mô tả các trường thông tin:
- Endpoint Name: Tên của endpoint
- Description: Mô tả mục đích của endpoint
- Configuration mode: Kiểu endpoint muốn tạo, trường hợp này chọn Basic.
Bước 3: Nhấn Create để lưu thông tin tạo mới hoặc Cancel để hủy thao tác tạo mới basic endpoint.
Bước 4: Hệ thống hiển thị màn hình chi tiết basic endpoint, thực hiện các thao tác cấu hình các thông tin cho basic endpoint.
Cấu hình giả lập basic endpoint
Để cấu hình basic endpoint, thực hiện cấu hình như sau:
Cấu hình thông tin chung
Bước 1: Cấu hình thông tin chung của endpoint tại tab General ở màn hình chi tiết endpoint, thực hiện nhập các thông tin.
Mô tả các trường thông tin:
- Service Visualization: Tên của endpoint
- Description: Mô tả mục đích của endpoint
Bước 2: Nhấn Save để lưu thông tin cấu hình vừa nhập.
Cấu hình thông tin endpoint
Bước 1: Cấu hình endpoint tại tab REST Mapping ở màn hình chi tiết endpoint, thực hiện nhập các thông tin.
Mô tả các trường thông tin:
- Method: Phương thức HTTP như GET, POST, PUT, DELETE…
- Path: Đường dẫn URI của endpoint ví dụ /auth, /login,...
- Cấu trúc dữ liệu đầu vào: Cấu hình các thông tin request:
- Request Params: Khai báo các query parameters, ví dụ ?page=1&limit=10.
- Request Body: Nhập nội dung dữ liệu gửi lên (thường dùng với method POST, PUT).
- Request Headers: Thêm các tiêu đề HTTP vào request
- Cấu trúc dữ liệu đầu ra: Cấu hình các thông tin response:
- Response Body: Khai báo nội dung phản hồi cố định mà API sẽ trả về khi được gọi. Có thể chọn định dạng nội dung phản hồi là JSON, XML, Text, HTML bằng cách nhấn vào button JSON ở góc phải phía trên.
- Response Headers: Khai báo các header đi kèm phản hồi
Bước 2: Nhấn Save để lưu thông tin cấu hình vừa nhập.
Start basic endpoint
Sau khi hoàn thành việc cấu hình basic endpoint, để start basic endpoint thực hiện như sau:
Bước 1: Nhấn button Start tại góc phải trên thanh toolbar ở màn hình chi tiết hoặc nhấn vào biểu tượng 
ở ô Actions tại danh sách Endpoint ở màn hình Overview.
Bước 2: Hệ thống hiển thị màn hình pop up xác nhận Start basic endpoint.
Bước 3: Nhấn OK để xác nhận Start basic endpoint hoặc Cancel để hủy thao tác.
Gửi yêu cầu basic endpoint
Sau khi start basic endpoint, để gửi yêu cầu basic endpoint thực hiện như sau:
Bước 1: Nhấn vào button Try it out tại tab Try It Now ở thông tin đặc tả API (OpenAPI Specification) của basic endpoint tại màn hình chi tiết endpoint. Thực hiện nhập dữ liệu đầu vào.
Bước 2: Nhấn Execute để gửi yêu cầu basic endpoint và kiểm tra kết quả trả về.
Stop basic endpoint
Sau khi start basic endpoint, để stop basic endpoint thực hiện như sau:
Bước 1: Nhấn button Stop tại góc phải trên thanh toolbar ở màn hình chi tiết hoặc nhấn vào biểu tượng 
ở ô Actions tại danh sách Endpoint ở màn hình Overview.
Bước 2: Hệ thống hiển thị màn hình pop up xác nhận Stop basic endpoint.
Bước 3: Nhấn OK để xác nhận Stop basic endpoint hoặc Cancel để hủy thao tác.
Chỉnh sửa basic endpoint
Để chỉnh sửa basic endpoint thực hiện như sau:
Bước 1: Nhấn vào biểu tượng 
ở ô Actions tại danh sách Endpoint ở màn hình Overview.
Bước 2: Hệ thống hiển thị màn hình chi tiết basic endpoint, thực hiện chỉnh sửa cấu hình basic endpoint tương tự như bước cấu hình.
Xóa basic endpoint
Để xóa basic endpoint thực hiện như sau:
Bước 1: Nhấn vào biểu tượng 
ở ô Actions tại danh sách Endpoint ở màn hình Overview.
Bước 2: Hệ thống hiển thị màn hình pop up xác nhận xóa basic endpoint.
Bước 3: Nhấn Yes để xác nhận xóa endpoint hoặc No để hủy thao tác xóa basic endpoint.