Tài liệu giới thiệu về REST API, bao gồm các khái niệm cơ bản, cấu trúc endpoint và các phương thức HTTP như GET, POST, PUT, DELETE. Nó trình bày các nguyên tắc thiết kế của REST cũng như أهمية من الوثائق والتي تشمل الوظائف والمواقع والطريقة. Cuối cùng, tài liệu cung cấp thông tin về cách xây dựng ứng dụng dự đoán đường cong địa vật lý giếng khoan thông qua API.

1. Giới thiệu về REST API
June 2024

2. 2. Giới thiệu về REST API
1. Giới thiệu về API
Table of contents
Description
4. API Document
3. Use Case: API Data Products

3. Giới thiệu về APIs và Postman | 3
1. API (1/2)
API là giao thức giúp các ứng dụng khác nhau tương tác được với nhau
Chrome Send Request
API
API = Application Programming Interface
GET https://graph.facebook.com/USER-ID
Get Response
{“name”: “nhu duc”, ”id”: “12345”, “avatar”: “picture1.png”}
Client Server
Database

4. Giới thiệu về APIs và Postman | 4
1. API (2/2)
Send Input file
Client Server
Get Predicted log
API
Nhu cầu: Xây dựng ứng dụng Power App để dự đoán đường cong địa vật lý giếng khoan ?
Input: File chứa dữ liệu giếng khoan
Output: Đường cong dự báo
- FrontEnd - Backend

5. Giới thiệu về APIs và Postman | 5
2. REST API (1/3)
REST API = Representational State Transfer API
REST là kiểu kiến trúc API dựa trên một tập hợp nguyên tắc thiết kế cụ thể
 Uniform Resource Identifier: Mỗi tài nguyên được truy xuất thông qua một URI duy nhất
GET https://graph.facebook.com/v5/user/USER-ID
 Sử dụng các phương thức HTTP: GET - POST - PUT - DELETE
 GET: Truy xuất tài nguyên có sẵn trên Server
 POST: Tạo mới tài nguyên trên Server
 PUT: Cập nhật tài nguyên hiện có
 DELETE: Xoá tài nguyên trên Server
GET https://graph.facebook.com/v5/post/POST-ID
 Phiên bản hoá và tài liệu hoá
 Các nguyên tắc khác: Thiết kế hướng tài nguyên, truyền dữ liệu (JSON/XML), Stateless,….
Mỗi phiên bản API đều được quản lý và có tài liệu hướng dẫn cụ thể về cách sử dung, Input, Output, tham số,…

6. Giới thiệu về APIs và Postman | 6
2. REST API (2/3)
Endpoint = Method + Base URI + Version + Resource Path + Path Parameters + Query Parameters
• Mỗi API gồm nhiều Endpoint
• Mỗi Endpoint là duy nhất, xác định một tài nguyên cụ thể
 https://apim4oilgasai.azure-api.net/v1/data-products/databases/lng
 https://apim4oilgasai.azure-api.net/v1/data-products/databases/crudoil
• Cấu trúc cơ bản của một Endpoint:
GET https://apim4oilgasai.azure-api.net/v1/data-
products/databases/:databasename/:tablename?api_key=57f8795
1 2 3 4 5 6

7. Giới thiệu về APIs và Postman | 7
Endpoint = Method + Base URI + Version + Resource Path + Path Parameters + Query Parameters
GET https://apim4oilgasai.azure-api.net/v1/data-
products/databases/:databasename/:tablename?api_key=57f8795
1 2 3 4 5 6
2. REST API (3/3)
Địa chỉ Server
• Endpoint Path: Xác định một tài nguyên cụ thể trên Server
• Query Parameter: Phục vụ cho việc xử lý dữ liệu bên trong Endpoint
Query Parameters
Vị trí resource trên Server
Mỗi Endpoint Path xác định một tài nguyên cụ thể trên Server

8. Giới thiệu về APIs và Postman | 8
3. Use Case: Data-Products API
Send Request
API
Get Response
GET https://apim4oilgasai.azure-api.net/v1/data-
products/databases/:databasename/:tablename
Server
Azure Container App
Client

9. Giới thiệu về APIs và Postman | 9
4. API Document
• API Document: Là tài liệu hướng dẫn sử dụng API
• Nội dung của API Document:
1. Giới thiệu ngắn gọn về API, mục đích và chức năng
2. Liệt kê tất cả các Endpoints có trong API, giới thiệu ngắn gọn về từng Endpoint
3. Hướng dẫn sử dung từng Endpoint:
 URI của Endpoint
 Mô tả chức năng
 Phiên bản của Endpoint
 Các phương thức sử dung: GET, POST, PUT, DELETE,…
 Mô tả định dạng dữ liệu Input, Output
 Xác thực và quyền truy cập
 Mã lỗi và xử lý lỗi
 Ví dụ cụ thể

10. Thank you