Azure Management API: Hướng Dẫn Tạo API Từ OpenAPI Specification - Part 1

Đây là series mình tổng hợp kiến thức về Azure API Management. Mong là tới cuối cùng, mình sẽ hiểu được hầu hết những phần hay trong APIM

Azure API Management là gì?

Azure API Management (APIM) là một giải pháp do Microsoft cung cấp, cho phép các lập trình viên dễ dàng xây dựng các API để kết nối các ứng dụng nội bộ và bên ngoài mà không cần viết bất kỳ dòng mã nào. APIM hoạt động ở lớp trên cùng của các dịch vụ Backend và đóng vai trò như một proxy.

Với APIM, bạn có thể quản lý API của mình, định nghĩa các chính sách (policies) cho việc public, sử dụng và giới hạn các ứng dụng chạy trên web hoặc cloud. Tất cả những thao tác này có thể thực hiện dễ dàng thông qua một giao diện APIM.

Deep dive về APIM: Azure API Management Deep Dive

https://learn.microsoft.com/en-us/azure/api-management/api-management-key-concepts

Cấu hình APIM

Chuẩn bị

• Một tài khoản Azure đang hoạt động
• Quyền Owner hoặc Contributor trong subscription

Các bước tạo Azure API Management

1. Truy cập Azure Portal

• Đăng nhập vào Azure Portal
• Click vào nút "Create a resource" (dấu + ở góc trái trên)

2.  Tìm API Management

• Trong thanh tìm kiếm, gõ "API Management"
• Chọn "API Management" từ kết quả tìm kiếm
• Click nút "Create".

 Lưu ý: bạn cần ghi nhớ Base URL

3. Cấu hình cơ bản
Trong tab Basics, điền các thông tin sau:

• Subscription: Chọn subscription của bạn
• Resource Group:
• Chọn một nhóm có sẵn hoặc
• Click "Create new" để tạo mới
• Region: Chọn khu vực gần nhất với người dùng của bạn
• Resource name: Đặt tên cho instance API Management
• Organization name: Tên tổ chức của bạn
• Administrator email: Email của admin

API Pet Store

PetStore API là một API giả lập phổ biến trong cộng đồng phát triển phần mềm. Nó được sử dụng như một ví dụ chuẩn để minh họa cách thiết kế và triển khai OpenAPI Specification (Swagger). API này cung cấp các endpoint để quản lý thông tin về thú cưng, đơn đặt hàng, và người dùng.
URL OpenAPI: https://petstore.swagger.io/v2/swagger.json
Các endpoint nổi bật:

• GET /pet/{petId}: Truy vấn thông tin một thú cưng.
• POST /store/order: Đặt hàng cho thú cưng.
• GET /user/{username}: Lấy thông tin một người dùng.

Bạn có thể test thử API tại đây: https://petstore.swagger.io

Tạo API Mới trong Azure API Management

Link: Pinterest

Trong Azure Portal, tìm kiếm và vào API Management Service của bạn. Trong tab APIs, chọn + Add API.
Chọn OpenAPI Specification trong danh sách các tùy chọn.

Ở mục OpenAPI specification, nhập URL:

https://petstore.swagger.io/v2/swagger.json

Điền thông tin API: 

• Display name: PetStore API.
• API URL suffix: petstore. 

Bấm Create để hoàn tất

Bạn vào Tab Test để thực hiện test API. Giả sử mình call api findByStatus

https://<your-apim-url>.azure-api.net/petstore/pet/findByStatus?status=available

Response

[{
    "id": 9223372036854752111,
    "category": {
        "id": 0,
        "name": "string"
    },
    "name": "doggie",
    "photoUrls": ["string"],
    "tags": [{
        "id": 0,
        "name": "string"
    }],
    "status": "available"
}, {
    "id": 9223372036854752112,
    "category": {
        "id": 0,
        "name": "string"
    },
    "name": "morce",
    "photoUrls": ["string"],
    "tags": [{
        "id": 0,
        "name": "string"
    }],
    "status": "available"
}, {
    "id": 9223372036854752114,
    "category": {
        "id": 0,
        "name": "string"
    },
    "name": "doggie",
    "photoUrls": ["string"],
    "tags": [{
        "id": 0,
        "name": "string"
    }],
    "status": "available"
}
]

Cập nhật API

Mở API cần cập nhật. Chọn Settings -> Import -> Replace API.

Nhập URL OpenAPI mới (ví dụ: https://petstore.swagger.io/v2/swagger.json) hoặc tải file .json/.yaml từ máy tính lên.

Lưu ý:

APIM chỉ chấp nhận Swagger/Open API từ 2.0 (còn gọi là Swagger Specification) và OpenAPI Specification 3.0.

Ví dụ trong file json của Petstore, phần mở đầu có ghi swagger info

{"swagger":"2.0",....

Setting Azure API Management

Trong tab Settings của API Management trong Azure, mục Subscription và các option liên quan đến Ocp-Apim-Subscription-Key có vai trò quản lý quyền truy cập vào API của bạn

Subscription (Đăng ký) là một cơ chế để kiểm soát và theo dõi việc sử dụng API. Khi bạn bật Subscription trong Azure API Management:

Người dùng phải có Subscription Key để gửi yêu cầu tới API của bạn.
Subscription Key được sử dụng để:

• Xác thực người dùng hoặc ứng dụng truy cập API.
• Theo dõi việc sử dụng API theo người dùng hoặc ứng dụng.
• Quản lý mức độ sử dụng thông qua các rate limits hoặc quotas.

Tham khảo

How to Set up Azure API Management?