Chuyển tới nội dung chính

Terms

TerminologyDefinition
Dự ánMột không gian làm việc logic nhóm các API, cổng và người dùng. Tất cả các cấu hình và triển khai được quản lý theo từng dự án.
Cổng APIMột thành phần xử lý các yêu cầu API của khách hàng, thực thi các chính sách và định tuyến các yêu cầu đến các dịch vụ backend.
URL CổngĐiểm cuối bên ngoài được gán cho một Cổng API, cho phép truy cập vào các API đã triển khai.
Lớp IngressMột cấu hình Kubernetes được sử dụng để chỉ định controller ingress nào (ví dụ: NGINX, Kong) để sử dụng.
Chính sách CổngMột quy tắc hoặc logic áp dụng cho các yêu cầu hoặc phản hồi API, chẳng hạn như xác thực, ghi log hoặc biến đổi.
Chính sách InboundMột chính sách được thực thi trước khi yêu cầu được chuyển tiếp đến backend.
Chính sách OutboundMột chính sách được thực thi sau khi backend phản hồi nhưng trước khi khách hàng nhận được phản hồi.
Cổng KongCông cụ cổng API mã nguồn mở được hệ thống APIM sử dụng để quản lý lưu lượng API.
KubernetesMột nền tảng mã nguồn mở cho việc điều phối container, được APIM sử dụng để triển khai và mở rộng các cổng.
PodMột đơn vị triển khai cơ bản trong Kubernetes chứa một hoặc nhiều container. Các Cổng APIM chạy dưới dạng pods.
AffinityMột cấu hình Kubernetes kiểm soát việc đồng vị trí của pods trên các nút cụ thể.
TolerationMột cài đặt Kubernetes cho phép các pods chạy trên các nút có các taint cụ thể.
Phân bố TopologyMột cấu hình đảm bảo rằng các pods cổng được phân phối đều trên các nút hoặc vùng.
APIMột giao diện được định nghĩa cho phép giao tiếp giữa các dịch vụ phần mềm. Trong APIM, các API được công khai cho các khách hàng bên ngoài.
Sản phẩm APIMột gói đã công bố của một hoặc nhiều API được nhóm lại cho việc tiêu thụ của nhà phát triển.
Đăng ký APIMột yêu cầu được thực hiện bởi một nhà phát triển để có quyền truy cập vào một sản phẩm API cụ thể.
Cổng Nhà phát triểnMột giao diện web nơi các nhà phát triển có thể duyệt, yêu cầu quyền truy cập và kiểm tra các API có sẵn.
Người dùng DevMột nhà phát triển bên ngoài sử dụng Cổng Nhà phát triển để truy cập và tiêu thụ các API.
Nhà phát triểnMột vai trò người dùng đại diện cho ai đó tiêu thụ các API thông qua Cổng Nhà phát triển.
Bảng điều khiển APIMGiao diện quản trị để quản lý các dự án, API, chính sách, cổng và người dùng.
Bảng điều khiển Yêu cầuMột bảng điều khiển giám sát hiển thị số lượng yêu cầu API, mã trạng thái và hiệu suất theo thời gian.
Bảng điều khiển Báo cáoMột công cụ báo cáo lịch sử để xem thống kê sử dụng API trên các dự án hoặc API.
Bảng điều khiển Thời gian thựcMột bảng điều khiển hiển thị các chỉ số lưu lượng API trực tiếp và tỷ lệ lỗi.
Kiểm tra APIMột công cụ kiểm tra cho phép người dùng thực hiện các yêu cầu API trực tiếp qua Swagger UI.
SwaggerMột khung (OpenAPI Specification) được sử dụng để định nghĩa và tương tác với các API RESTful.
OpenAPITên chính thức của đặc tả Swagger được sử dụng cho tài liệu và kiểm tra API.
JWTJSON Web Token - một định dạng token gọn nhẹ được sử dụng để truyền tải an toàn các yêu cầu giữa các bên.
Giới hạn Tốc độMột chính sách hạn chế số lượng yêu cầu API được phép trong một khoảng thời gian cụ thể.
RedisMột kho dữ liệu trong bộ nhớ được cổng sử dụng cho dữ liệu tạm thời như giới hạn tốc độ hoặc bộ nhớ cache token.
Fluent BitMột bộ xử lý log được sử dụng để thu thập và chuyển tiếp các log cổng đến các công cụ quan sát bên ngoài.
Chú thíchMột cặp khóa-giá trị được sử dụng để cấu hình metadata cho các tài nguyên Cổng hoặc Ingress.
Chú thích IngressCác chú thích cụ thể được sử dụng trong Kubernetes để tinh chỉnh hành vi ingress, chẳng hạn như timeout hoặc viết lại đường dẫn.
Bộ biến đổi Yêu cầuMột chính sách thay đổi cấu trúc hoặc nội dung của các yêu cầu API đến.
Bộ biến đổi Phản hồiMột chính sách thay đổi cấu trúc hoặc nội dung của các phản hồi API đi ra.
Kết thúc Yêu cầuMột chính sách dừng xử lý yêu cầu và trả về một phản hồi lỗi cố định dựa trên các quy tắc đã định nghĩa.
Giới hạn IPMột chính sách cho phép hoặc từ chối quyền truy cập vào các API dựa trên địa chỉ IP của khách hàng.
Chính sách TimeoutMột chính sách xác định thời gian mà hệ thống chờ đợi một yêu cầu hoặc phản hồi trước khi hết thời gian.
Giới hạn Kích thước Yêu cầuMột chính sách hạn chế kích thước tối đa của các payload yêu cầu API.
Log StdoutMột chính sách ghi lại thông tin yêu cầu và phản hồi vào đầu ra tiêu chuẩn để gỡ lỗi hoặc kiểm toán.
Triển khaiHành động áp dụng các cấu hình và chính sách API cho một phiên bản Cổng.
Môi trườngMột giai đoạn logic như phát triển, staging hoặc sản xuất, mỗi giai đoạn có các cài đặt và điểm cuối riêng.
Yêu cầu Đăng kýMột yêu cầu chính thức từ một nhà phát triển để đăng ký một sản phẩm API.
Phê duyệt Thủ côngMột quy trình làm việc mà một quản trị viên xem xét và phê duyệt quyền truy cập hoặc đăng ký một cách thủ công.
Vai trò Người dùngMột tập hợp các quyền được gán cho một người dùng (ví dụ: Quản trị viên, Quản lý API, Người xem) trong một dự án.
Mẫu Chính sáchMột cấu hình preset có thể tái sử dụng cho một chính sách cổng, được sử dụng để đơn giản hóa các thiết lập lặp lại.