Xem thông tin API Catalog
Màn hình API Catalog liệt kê các API đã đăng ký của tổ chức ở cấp tenant, nên không có ô chọn API Gateway như các màn Route, Service, Upstream.
Nhấn vào ảnh để phóng to.
Xem danh sách API Catalog
- Chọn API Gateway → API Catalog ở menu bên trái.
Bảng danh sách gồm các cột:
| Cột | Mô tả |
|---|---|
| Name | Tên API. Nhấn vào tên để mở màn hình chi tiết. |
| Description | Mô tả API. |
| Version | Phiên bản API. |
| Spec type | Loại đặc tả của API, ví dụ openapi. |
| Created At | Thời điểm tạo. |
| Created By | Người tạo API. |
| Owner | Nhóm sở hữu API. |
| Lifecycle | Giai đoạn vòng đời: experimental, production hoặc deprecated. |
| Tags | Nhãn phân loại API. |
| ⋮ | Menu thao tác trên từng dòng, xem bảng thao tác bên dưới. |
Thanh công cụ có ô Search để tìm API theo từ khóa, nút Create API Catalog để tạo API Catalog và nút Column để chọn, ẩn và sắp xếp cột hiển thị. Nút Refresh ở góc trên bên phải tải lại danh sách.
Cuối bảng có Rows per page để chọn số dòng mỗi trang, mặc định 10. Khi chưa có API nào, màn hình hiển thị hình minh họa kèm nút Create API Catalog.
Menu ⋮ ở cuối mỗi dòng có 2 thao tác:
| Thao tác | Mô tả |
|---|---|
| Deploy to gateway | Tạo Route từ toàn bộ endpoint của API. Xem Triển khai API Catalog lên API Gateway. |
| Delete | Xóa API khỏi catalog. Xem Xóa API Catalog. |
Xem chi tiết API
- Nhấn vào Name của API cần xem. Màn hình chi tiết gồm 3 tab: Overview (mặc định), API Definition và API Deploy.
Tab Overview
Mục Basic information hiển thị thông tin cơ bản của API.
| Thông tin | Mô tả |
|---|---|
| Name | Tên API. |
| Lifecycle | Giai đoạn vòng đời: experimental, production hoặc deprecated. |
| Tags | Nhãn phân loại API. |
| Description | Mô tả API. |
| Type | Loại đặc tả, ví dụ openapi. |
| Owner | Nhóm sở hữu API. |
| Source | Liên kết tới spec gốc, khi API được import từ URL. |
| Created At, Created By | Thời điểm tạo và người tạo API. |
Nhấn Edit để sửa thông tin cơ bản, xem Chỉnh sửa API Catalog.
Tab API Definition
Hiển thị spec của API dưới dạng trình xem trực quan (Swagger UI):
- Tên API kèm phiên bản và mô tả.
- Danh sách endpoint, nhóm theo tag (ví dụ
pet,store,user). Nhấn vào một endpoint để xem chi tiết request và response. - Authorize: khai báo thông tin xác thực để thử gọi API ngay trong trang.
- Download: tải file spec gốc về máy.
- Schemas: các model dữ liệu của spec, nằm cuối trang.
Tab API Deploy
Liệt kê mọi endpoint trong spec của API với các cột Host, HTTP method, Path, Name, Group. Tại tab này, bạn chọn endpoint để tạo Route trên API Gateway, xem Triển khai API Catalog lên API Gateway.
