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

API Creation / Deployment / Invocation

Tổng quan

Hướng dẫn này trình bày toàn bộ vòng đời API trong APIM - từ việc tạo một định nghĩa API mới, triển khai nó lên một Gateway, và xác minh việc gọi API thông qua yêu cầu HTTP. Quy trình bao gồm các cấu hình thực tế phổ biến như thiết lập đường dẫn yêu cầu, chọn mục tiêu triển khai, và kiểm tra phản hồi API sau khi triển khai.

Điều kiện tiên quyết

Đảm bảo rằng các điều kiện sau đây đã được thiết lập:

  • Một Gateway đã tồn tại và đang hoạt động (ví dụ: gateway-prod-mj)
  • Bạn có quyền truy cập vào APIM Console với quyền Developer hoặc Admin
  • Một dự án đã được tạo (pj-test-01)
  • Ít nhất một URL Gateway đã được đăng ký (ví dụ: https://api.sksample.co.kr/gateway-test-01)

Hướng dẫn từng bước

Bước 1. Tạo một API mới

Đi tới Quản lý API. Nhấp vào Tạo API

TrườngVí dụ
Tên APIuser-service-api
Đường dẫn cơ sở/user-service
Mô tảXử lý đăng ký và đăng nhập người dùng
Tính khả dụngRiêng tư
Thẻuser, auth, v1

Nhấp vào Tiếp theo để tiến hành định nghĩa phiên bản.

Bước 2. Định nghĩa phiên bản API

TrườngVí dụ
Tên phiên bảnv1.0
URL mục tiêu (Backend)https://backend.sksample.co.kr/user
Gatewaygateway-prod-mj
Phương thức yêu cầuGET, POST, PUT, DELETE
Cắt đường dẫn cơ sởBật (tùy chọn dựa trên định dạng backend)

Nhấp vào Lưu & Triển khai

Bước 3. Triển khai API lên Gateway

Khi API đã được lưu:

  • Đi tới màn hình Cấu hình API
  • Xem lại và xác nhận thông tin
  • Nhấp vào Triển khai (với phiên bản v1.0 đã được chọn)
  • Chờ trạng thái cập nhật thành Đã triển khai. Bạn có thể triển khai lại sau khi chỉnh sửa.

Bước 4. Kiểm tra API đã triển khai

Bạn có thể kiểm tra API bằng bất kỳ khách hàng HTTP nào (Postman, curl, trình duyệt, v.v.)

Ví dụ kiểm tra với curl:

curl -X GET "[https://api.sksample.co.kr/gateway-test-01/user-service/v1/status](https://api.sksample.co.kr/gateway-test-01/user-service/v1/status)"


Phản hồi mong đợi:

{
"status": "ok",
"service": "user-service",
"version": "v1.0"
}

Các vấn đề thường gặp & Khắc phục sự cố

Issue Cause Solution
404 Không tìm thấyĐường dẫn không chính xácKiểm tra lại cài đặt BasePath và RoutePath
Lỗi SSLGateway không có chứng chỉ hợp lệĐảm bảo HTTPS được bật và chứng chỉ TLS là hợp lệ
Hết thời gianURL mục tiêu backend không thể truy cậpXác minh DNS và quyền truy cập mạng từ gateway đến backend
403 Bị cấmCần khóa APIKiểm tra xem các chính sách xác thực có được bật không

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

  • Giữ BasePath và RoutePath sạch sẽ và có phiên bản (ví dụ: /api-name/v1)
  • Chỉ triển khai đến các Gateway đã được xác thực với cấu hình TLS và URL cơ sở phù hợp
  • Kiểm tra với curl hoặc Postman trước khi chia sẻ với người tiêu dùng
  • Sử dụng Tags để nhóm hợp lý (ví dụ: công khai, nội bộ, v2)
  • Duy trì lịch sử phiên bản để quay lại và lặp lại