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

Developer Portal API Product Publication

Tổng Quan​

Hướng dẫn này sẽ hướng dẫn bạn qua quy trình tạo và xuất bản Sản phẩm API trên Cổng thông tin Nhà phát triển. Một Sản phẩm trong APIM nhóm nhiều API lại với nhau và cho phép bạn định nghĩa siêu dữ liệu cấp sản phẩm như tiêu đề, mô tả, logo và liên kết tài liệu. Các sản phẩm đã xuất bản sẽ trở nên khả dụng cho các nhà phát triển để khám phá và sử dụng.

Điều Kiện Tiên Quyết​

  • Ít nhất một API đã triển khai có sẵn trong Bảng điều khiển APIM của bạn
  • Quyền truy cập quản trị vào Quản trị > Quản lý Sản phẩm

Hướng Dẫn Từng Bước​

Bước 1. Tạo Sản phẩm Mới​

Đi tới Quản trị > Quản lý Sản phẩm, sau đó nhấp vào nút cộng.

Trong cửa sổ bật lên:

  • Nhập Tên Sản phẩm: sk01
  • Nhấp vào Xác nhận để tiếp tục.

Bước 2. Điền Thông tin Cơ bản về Sản phẩm​

Sau khi tạo sản phẩm, bạn sẽ được chuyển hướng đến trang chi tiết.

Field Example
Tênsk01 (tự động điền)
Mô tảAPI quản lý xác thực và người dùng
Liên kết Giới thiệu Sản phẩmhttps://developers.skapim.co.kr/product/sk01/overview
Bật Sản phẩm Đã chọn(hiển thị trên Cổng thông tin Nhà phát triển)
Bật Liên kết Tài liệu API Đã chọn(kích hoạt quyền truy cập tài liệu API trong trang chi tiết sản phẩm)
Biểu tượng Sản phẩmicon-sk01.png (tỷ lệ 1:1, kích thước hiển thị 40x40px)

Nhấp vào Lưu để lưu thông tin cơ bản.

Bước 3. Thêm API vào Sản phẩm​

Chuyển sang tab API trong chế độ xem chi tiết sản phẩm.

Nhấp vào nút Thêm để gán API cho sản phẩm này.

Các Trường API Có sẵn:

TrườngVí dụ
Dự ánmj-test-kong
Cổngmj-test-kong-gateway
APItestFromBff0052
Mô tảhelloworld2222
Thẻ

Nhấp vào biểu tượng kiểm tra để hoàn tất việc thêm.

Bạn có thể:

  • Thêm nhiều API
  • Xóa API (biểu tượng X)
  • Xem hoặc chỉnh sửa từng API (biểu tượng bánh răng hoặc biểu tượng xem)

Bước 4. Kích hoạt Sản phẩm trên Cổng thông tin Nhà phát triển​

Quay lại Danh sách Sản phẩm, bạn sẽ thấy mục mới của mình.

CộtMô tả
Hộp kiểmChuyển đổi để xuất bản hoặc ẩn sản phẩm trên Cổng thông tin Nhà phát triển
Thứ tựĐịnh nghĩa thứ tự hiển thị trong danh sách sản phẩm (0 = trên cùng)

Nhấn Lưu Thứ tự sau khi chỉnh sửa vị trí hiển thị.

Thực hành tốt nhất​

  • Giữ tên sản phẩm có ý nghĩa và độc đáo
  • Sử dụng biểu tượng tỷ lệ 1:1 (40x40px) để hiển thị nhất quán
  • Nhóm các API liên quan thành một sản phẩm duy nhất để dễ dàng khám phá
  • Sử dụng Liên kết Giới thiệu Sản phẩm để kết nối người dùng với tài liệu hoặc tổng quan kinh doanh
  • Sử dụng thẻ để tổ chức nội bộ và bộ lọc giao diện người dùng