Thêm Plugin
Bạn thêm plugin theo một trong 2 cách. Cả 2 cách đều dùng chung popup Add plugin và màn hình Create Plugin.
| Cách | Dùng khi |
|---|---|
| Từ màn hình Plugin | Tạo plugin mới, chọn Scope tự do (Global hoặc nhiều Route / Service, riêng plugin Rate Limiting gán được cả Consumer). |
| Từ màn hình chi tiết Route / Service | Gắn plugin cho đúng Route / Service đang xem, dùng lại plugin đã có hoặc tạo mới. |
Khái niệm Scope, plugin trực tiếp / kế thừa xem tại Tổng quan Plugin.
Thêm từ màn hình Plugin
Để thêm Plugin từ màn hình Plugin, bạn thực hiện các bước sau:
-
Chọn API Gateway → Plugin ở menu bên trái, chọn API Gateway ở góc trên bên phải, rồi nhấn New plugin.
-
Chọn loại plugin trong popup Add plugin. Nhập tên vào ô Search plugins by name... để tìm nhanh.
- Nhập thông tin trên màn hình Create Plugin vừa mở ra, theo mục Nhập thông tin plugin. Nhãn cạnh tiêu đề là loại plugin đã chọn.
Thêm từ màn hình chi tiết Route hoặc Service
Để thêm Plugin cho một Route hoặc Service, bạn thực hiện các bước sau:
-
Mở màn hình chi tiết Route (API Gateway → Route → nhấn vào tên Route) hoặc Service (API Gateway → Service → nhấn vào tên Service).
-
Chọn tab Plugins. Tab con Explicit Plugin (mặc định) liệt kê plugin gắn trực tiếp, tab con Implicit Plugin liệt kê plugin kế thừa. Tại Explicit Plugin, nhấn Add Plugin.
- Chọn loại plugin trong popup Add plugin, rồi chọn một trong 2 cách tại mục Select policy:
| Lựa chọn | Mô tả |
|---|---|
| Select existing plugin (mặc định) | Dùng lại một plugin cùng loại đã tạo. Chọn plugin trong danh sách thả xuống. |
| Create new plugin | Tạo plugin mới và gắn vào Route / Service này. |
- Nhấn Continue. Nếu chọn Create new plugin, màn hình Create Plugin mở ra với mục Scope đã gán sẵn Route / Service đang xem. Nhập tiếp thông tin theo mục Nhập thông tin plugin.
Nhập thông tin plugin
Màn hình Create Plugin chia 3 mục ở thanh điều hướng bên trái: Basic Information, Scope, Configuration. Mục nào còn thiếu dữ liệu bắt buộc có biểu tượng ⓘ màu đỏ, nút Create chỉ bật khi cả 3 mục hợp lệ.
Basic Information
| Field | Bắt buộc | Mô tả |
|---|---|---|
| Display Name | N | Tên bạn đặt cho plugin này, khác với tên loại plugin (ví dụ JWT Auth). Bắt đầu bằng chữ cái, chỉ gồm chữ a-z, số 0-9, _, dấu cách và -. |
| Description | N | Mô tả plugin, điền sẵn theo mô tả của loại plugin, sửa được. |
| Enabled | N | Bật plugin ngay khi tạo. Mặc định bật. |
Scope
| Lựa chọn | Mô tả |
|---|---|
| Global | Áp dụng cho mọi Service, Route và Consumer của API Gateway. |
| Scoped | Chỉ áp dụng cho Route / Service cụ thể. Tại Assign Policy to, nhấn + Add Route hoặc + Add Service, chọn đối tượng rồi nhấn Apply. Các đối tượng đã chọn hiển thị trong bảng ID / Name / Type, nhấn biểu tượng thùng rác để gỡ. |
Configuration
Mục Configuration gồm form thuộc tính riêng của từng loại plugin, và khung JSON bên phải hiển thị cấu hình tương ứng (chỉ đọc). Khung JSON có nút Copy để sao chép và Reset để đưa về mặc định.
- Attribute (N): mở panel Manage Attribute để chọn thuộc tính hiển thị trên form. Selected Attributes là thuộc tính đang hiển thị (nhãn R là bắt buộc), Available Attributes là thuộc tính có thể bật thêm, nhấn + để thêm.
- Quick Start Templates (chỉ có ở một số plugin): nhấn Use Template trên thẻ tương ứng để điền nhanh cấu hình mẫu. Template chỉ điền giá trị giữ chỗ, bạn cần thay bằng giá trị thật trước khi tạo.
Thuộc tính của từng loại plugin xem tại trang hướng dẫn plugin đó, liệt kê ở Tổng quan Plugin.
Hoàn tất
Nhấn Create. Thông báo Plugin created successfully hiển thị, hệ thống đưa bạn về màn hình Plugins và plugin mới xuất hiện với cột Applied to đúng phạm vi đã chọn.
Nếu gán Scoped, bạn kiểm tra lại tại tab Plugins của Route / Service tương ứng.