Quản lý REST APIs

REST APIs là thành phần cốt lõi của API Management — cho phép bạn đăng ký, quản lý và phân phối API tới các consumer.

Khai báo REST APIs

Bước 1: Ở menu Application > API Manager > Rest Apis > chọn Create.

Bước 2: Nhập các thông tin cần thiết:

Name: Tên API.
Title: Tiêu đề cho API.
Base path: Đường dẫn để client gọi vào sau khi public API.
Use host group: Kích hoạt mode HA hoặc không.
Target endpoint: Endpoint của API hiện có, cần đưa ra cho consumer dùng.
Target Security: Thông tin xác thực của API.
Security method: Phương thức xác thực khi client sử dụng API. Hỗ trợ Basic Authentication, OAuth và Api Key.
Enable doc: Tạo doc cho API.
Enable validation schema: Thêm validation cho body request.

cảnh báo

Security method sẽ không thể thay đổi sau khi tạo. Hãy cẩn thận khi khai báo thông tin này.

Bước 3: Chọn OK để khởi tạo REST APIs.

ghi chú

Nếu nút Create bị disable, hãy kiểm tra lại gói dịch vụ API Management. Với gói Pilot, chỉ có thể khai báo tối đa 2 API.

Nếu bạn có nhiều API cần khai báo, hãy sử dụng tính năng import hàng loạt:

[
  {
    "name": "",
    "title": "",
    "base_path": "",
    "target_endpoint": "",
    "security_method": ""
  }
]

Bước 1: Ở Rest APIs Management > chọn REST API cần thay đổi > chọn Edit.

Bước 2: Nhập các thông tin mới và chọn OK.

Trước khi xóa, bạn cần đảm bảo REST API không gắn vào bất kỳ Product nào.

Bước 1: Ở Rest APIs Management > chọn REST API cần xóa > chọn Remove Api.

Bước 2: Trong popup xác nhận, chọn Yes để tiến hành xóa.

Nếu bạn muốn thêm hoặc sửa field với giá trị xác định trong request hoặc response, hãy sử dụng tính năng Transformer.

Ở Rest APIs Management > chọn REST API > Edit > tab Advance > Transformations.
Tích chọn Request Transformer hoặc Response Transformer, click Raw view và nhập thông tin cần thay đổi.

Bước 1: Ở menu Application > API Manager > Rest Apis > chọn API > Edit.

Bước 2: Chọn tab Advance > tab Security > tích vào ô Use CORS.

Bước 3: Nhập thông tin:

Access-Control-Allow-Origin: Nhập IP, domain cho phép truy cập API. Nếu để trống, tất cả domain đều được phép truy cập.