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

API Creation and Deployment

Khái niệm​

API là gì?​

Một API (Application Programming Interface) là một tập hợp các định nghĩa và giao thức cho phép các ứng dụng phần mềm giao tiếp với nhau. Trong bối cảnh của APIM (API Management), một API đại diện cho một tập hợp các thao tác có thể được gọi bởi các khách hàng, tạo điều kiện truy cập vào các dịch vụ backend.

Tại sao nên tạo một API?​

Việc tạo ra các API mang lại nhiều lợi ích cho cả nhà cung cấp và người tiêu dùng:

Đối với Nhà cung cấp:

  • Tính mô-đun: Đóng gói chức năng thành các dịch vụ có thể tái sử dụng.
  • Tính mở rộng: Tạo điều kiện cho việc phát triển các ứng dụng có thể mở rộng.
  • An ninh: Thực hiện kiểm soát truy cập và giám sát.
  • Kiếm tiền: Cung cấp API như là sản phẩm cho các nhà phát triển hoặc đối tác bên ngoài.

Đối với Người tiêu dùng:

  • Khả năng truy cập: Truy cập dịch vụ mà không cần hiểu các triển khai nội bộ.
  • Hiệu quả: Tích hợp nhanh chóng các chức năng vào ứng dụng.
  • Đổi mới: Xây dựng các giải pháp mới bằng cách kết hợp các API hiện có.

Vai trò của API trong APIM và Kong Gateway​

Trong APIM, các API phục vụ như là giao diện chính giữa các khách hàng và các dịch vụ backend. Chúng:

  • Định nghĩa cách mà các khách hàng tương tác với các dịch vụ.
  • Thực thi các chính sách như xác thực, giới hạn tần suất và chuyển đổi.
  • Giám sát việc sử dụng và các chỉ số hiệu suất.

Mỗi API được liên kết với một Dự án cụ thể và được triển khai thông qua một Gateway, đóng vai trò là thành phần runtime xử lý các yêu cầu API.

Kong Gateway nâng cao quản lý API bằng cách cung cấp:

  • Định tuyến nâng cao: Chỉ đạo các yêu cầu dựa trên nhiều tiêu chí khác nhau.
  • An ninh: Thực hiện xác thực, ủy quyền và mã hóa.
  • Khả năng quan sát: Giám sát việc sử dụng và hiệu suất API.
  • Tính mở rộng: Thêm các chức năng thông qua các plugin.

Lợi ích của việc tạo API thông qua APIM​

Thách Thức Quản Lý APIs Mà Không Có APIM​

Trong các môi trường truyền thống, việc tạo APIs trực tiếp trên các cổng như Kong (thông qua CLI, REST API hoặc tệp cấu hình) thường đi kèm với một số hạn chế:

  • Chi Phí Cấu Hình Thủ Công: Mỗi API phải được định nghĩa thủ công, làm tăng nguy cơ lỗi do con người và sự không nhất quán.
  • Thiếu Tầm Nhìn Trung Tâm: Các nhà phát triển và quản trị viên thiếu một cái nhìn duy nhất để quản lý, kiểm toán hoặc xem xét tất cả các API đã đăng ký.
  • Quản Lý Chính Sách Bị Phân Mảnh: Các chính sách bảo mật, giới hạn tốc độ và các biến đổi yêu cầu/phản hồi phải được áp dụng thủ công cho từng API, không có phiên bản hoặc lịch sử.
  • Hợp Tác Hạn Chế: Thiếu một nền tảng chung, sự hợp tác giữa các nhà phát triển, kiểm thử viên và quản lý trở nên không hiệu quả.
  • Không Hỗ Trợ Vòng Đời: Quản lý các phiên bản API, kiểm tra trước khi triển khai, hoặc theo dõi các thay đổi là khó khăn và yêu cầu viết kịch bản tùy chỉnh hoặc công cụ bên ngoài.

Những vấn đề này trở nên nghiêm trọng hơn khi số lượng APIs tăng lên, hoặc khi làm việc qua nhiều nhóm hoặc môi trường khác nhau.

APIM Giải Quyết Những Vấn Đề Này Như Thế Nào​

Hệ thống APIM cung cấp một lớp quản lý mạnh mẽ trên nền tảng Kong Gateway, cung cấp một cách quản lý APIs hiệu quả và có thể mở rộng. Các lợi ích của nó bao gồm:

  • Giao Diện Trực Quan: Người dùng có thể tạo, cấu hình và triển khai APIs thông qua một bảng điều khiển web thân thiện với người dùng—không cần sử dụng CLI hoặc chỉnh sửa tệp cấu hình thủ công.
  • Đăng Ký API Tập Trung: Tất cả các API được quản lý theo từng dự án, cho phép sở hữu, cách ly và quản lý rõ ràng.
  • Ứng Dụng Chính Sách Tích Hợp: Dễ dàng gắn các chính sách bảo mật, giới hạn, ghi nhật ký và biến đổi trong quá trình cấu hình API, với kiểm soát phiên bản rõ ràng.
  • Triển Khai Liền Mạch: Triển khai một lần nhấp đến các cổng cụ thể của dự án giảm thiểu lỗi và hỗ trợ các môi trường theo giai đoạn.
  • Phiên bản và Tài liệu Tích hợp: APIs có thể được phiên bản hóa, kiểm tra và tài liệu trong cùng một môi trường, cải thiện khả năng bảo trì.
  • Hợp tác Nhóm: Thông qua quyền truy cập dựa trên vai trò, các bên liên quan khác nhau (quản trị viên, nhà phát triển, kiểm thử viên) có thể đóng góp một cách an toàn trong ranh giới dự án.

Cuối cùng, APIM biến đổi cách APIs được xây dựng và duy trì bằng cách kết hợp sức mạnh runtime của Kong với một nền tảng quản lý có cấu trúc, giảm bớt gánh nặng vận hành và cho phép quy trình phát triển nhanh hơn, an toàn hơn.

Các bước để tạo một API​

Để tạo một API trong APIM, hãy làm theo các bước sau:

Truy cập vào Bảng điều khiển APIM​

Đăng nhập bằng thông tin xác thực apim-admin của bạn.

Chọn Dự án phù hợp và đi đến phần Quản lý API.

Thêm một API Mới​

Nhấp vào “+ Thêm API”. Chọn phương pháp để định nghĩa API của bạn.

Cấu hình Cài đặt API​

  • Tên: Một định danh duy nhất cho API.
  • Cổng: Gắn vào Cổng Kong của Dự án và URL Cổng
  • URL Dịch vụ Web: Điểm cuối dịch vụ backend.
  • Hậu tố URL API: Hậu tố được thêm vào URL cổng.
  • Mô tả: Chi tiết tùy chọn về API.
  • Định nghĩa Các hoạt động: Thêm các hoạt động (ví dụ: GET, POST) xác định các đường dẫn URL và tham số.

Áp dụng Chính sách​

Thực hiện các chính sách cho xác thực, giới hạn tỷ lệ, chuyển đổi, v.v.

Viết hoặc Cập nhật Tài liệu API​

Sử dụng trình soạn thảo Markdown tích hợp sẵn để viết hoặc cập nhật tài liệu API của bạn.

Xem trước nội dung và nhấp vào “Xuất bản”. Tài liệu sẽ có thể hiển thị trong menu Tài liệu API và trở nên có sẵn thông qua Cổng thông tin Nhà phát triển cho người dùng được ủy quyền.

Lưu API vào Quản lý API​

Lưu cấu hình API và xem các API đã được tạo trong màn hình Quản lý API.

ghi chú

Để biết hướng dẫn chi tiết và các tùy chọn bổ sung, vui lòng tham khảo Hướng dẫn Người dùng > Hướng dẫn Bảng điều khiển APIM > Quản lý API

Triển khai API​

Sau khi tạo API thành công, bạn có thể nhấp vào API đã tạo để truy cập màn hình cấu hình API. Từ đây, bạn có thể nhấp vào nút Triển khai API để triển khai API để nó có thể truy cập từ bên ngoài.

Mỗi lần triển khai API sẽ tạo ra một phiên bản mới cho nó. Bạn sẽ được yêu cầu nhập mô tả phiên bản mỗi khi bạn thực hiện triển khai cho một API.

Sau khi API được triển khai, người dùng có thể theo dõi trạng thái API và nhật ký triển khai thông qua menu Triển khai API.

Người dùng cũng có thể nhấp vào từng bản ghi Triển khai API riêng lẻ để xem chi tiết của một API và các phiên bản của nó.

Sau khi bước này hoàn tất, API hiện đã hoạt động trên Gateway và có thể truy cập qua URL Điểm cuối công khai của nó. Bạn có thể tiếp tục đến bước cuối cùng để kiểm tra API.