Tạo API Catalog
API Catalog là danh mục các API definition của tổ chức, nơi bạn đăng ký một API chỉ với tên hoặc kèm đặc tả OpenAPI (spec) lấy từ file hay từ URL. API Catalog ở cấp tenant, không thuộc API Gateway nào, nên được dùng chung cho mọi API Gateway: tạo Route với Method và Path điền sẵn từ endpoint trong spec, hoặc tạo Upstream với Target điền sẵn từ server list trong spec.
Nhấn vào ảnh để phóng to.
Tạo API Catalog
Màn hình tạo API là wizard 2 bước: API Information → Ownership & Metadata. Để tạo API Catalog, bạn thực hiện các bước sau:
-
Chọn API Gateway → API Catalog ở menu bên trái, nhấn Create API Catalog.
-
Chọn cách cung cấp spec tại màn API Information, mục Add API Specification:
| Field | Bắt buộc | Mô tả |
|---|---|---|
| OpenAPI specification source | N | Nguồn spec của API. Upload a spec file (mặc định): chọn file từ máy. Upload a spec from a URL: lấy spec từ một URL public. Bỏ trống nếu bạn chỉ đăng ký API bằng tên. |
| API Spec | N | Hiện khi chọn Upload a spec file. Nhấn Select file hoặc kéo thả file OpenAPI định dạng YAML hoặc JSON vào khung. |
| URL | N | Hiện khi chọn Upload a spec from a URL. URL trỏ tới file spec public, ví dụ https://petstore3.swagger.io/api/v3/openapi.json. |
Khi chọn Upload a spec from a URL: nhập URL rồi nhấn ra ngoài ô. Hệ thống tải spec, hiện thông báo Spec fetched successfully. Fields have been auto-filled. và tự điền API Name, API Version, API Description theo các trường info.title, info.version, info.description trong spec.
- Nhập hoặc kiểm tra lại các thông tin sau tại mục General Information:
| Field | Bắt buộc | Mô tả |
|---|---|---|
| API Name | Y | Tên API trong catalog, hiển thị ở danh sách và dùng để chọn API khi tạo Route hoặc Upstream từ API Catalog. |
| API Version | N | Phiên bản API, nên theo semantic versioning, ví dụ 1.2.0. |
| API Description | N | Mô tả mục đích của API. |
Bạn có thể sửa các giá trị vừa được tự điền, ví dụ đổi API Name cho dễ nhận biết trong catalog.
- Nhấn Next để chuyển sang màn Ownership & Metadata, nhập các thông tin sau:
| Field | Bắt buộc | Mô tả |
|---|---|---|
| Owner | N | Nhóm hoặc team sở hữu API, ví dụ app-team. Giúp phân rõ trách nhiệm quản lý khi catalog có nhiều API. |
| Lifecycle | N | Giai đoạn vòng đời của API: experimental (thử nghiệm), production (đang khai thác chính thức), deprecated (không khuyến nghị dùng, sắp loại bỏ). Hiển thị dạng tag ở danh sách và màn chi tiết để bạn biết nhanh API nào an toàn để dùng. |
| Tags | N | Nhãn phân loại API. Nhập một từ khóa rồi nhấn Enter để thêm, có thể thêm nhiều tag. Dùng để tìm và lọc các API liên quan. |
- Nhấn Create để hoàn tất. Muốn sửa màn trước, nhấn Previous.
Thông báo API created successfully hiển thị, hệ thống đưa bạn về màn hình API Catalog và API mới nằm ở đầu danh sách.
