Viết API cần những kiến thức gì?

API là gì?

API là viết tắt của Application Programming Interface, được hiểu là một tập các quy tắc và giao thức mà các phần mềm và ứng dụng sử dụng để giao tiếp và tương tác với nhau. API định nghĩa các phương thức và định dạng dữ liệu cho phép các ứng dụng khác truy cập và sử dụng các tính năng hoặc dữ liệu của ứng dụng.

Lý do sử dụng API

API được sử dụng vì nhiều lý do quan trọng:

• Tích hợp và liên kết ứng dụng: API cho phép các ứng dụng khác nhau truy cập và sử dụng chức năng, dữ liệu hoặc tài nguyên của ứng dụng một cách dễ dàng. Điều này tạo điều kiện cho tích hợp và liên kết giữa các ứng dụng khác nhau, giúp tăng cường khả năng hoạt động và tận dụng các tính năng sẵn có từ các hệ thống khác.
• Phát triển ứng dụng một cách phân tán: Bằng cách sử dụng API, các nhà phát triển có thể xây dựng và triển khai các ứng dụng phân tán, trong đó mỗi thành phần có thể hoạt động độc lập và giao tiếp với nhau thông qua API. Điều này giúp phân tách logic và tăng khả năng mở rộng của hệ thống.
• Tiêu chuẩn hóa và tái sử dụng: API cung cấp một giao diện tiêu chuẩn cho phép các ứng dụng tuân thủ các quy tắc và giao thức đã được định nghĩa. Điều này giúp tạo ra sự nhất quán và tăng tính tái sử dụng, cho phép các ứng dụng sử dụng lại các phần mềm, thư viện hoặc dịch vụ đã được phát triển trước đó thông qua API.
• Phát triển ứng dụng di động và web: API chủ yếu được sử dụng để phát triển ứng dụng di động và web. Các ứng dụng này thường sử dụng API để truy cập và tương tác với các dịch vụ và tài nguyên trên mạng. Việc sử dụng API giúp phát triển ứng dụng linh hoạt, tận dụng tối đa khả năng của các dịch vụ và tạo trải nghiệm người dùng tốt hơn.

Để viết API bạn cần chuẩn bị những kiến thức gì?

Để tự học viết API, bạn cần chuẩn bị một số kiến thức cơ bản về các công nghệ và khái niệm sau:

• Ngôn ngữ lập trình: Đầu tiên, bạn cần chọn một ngôn ngữ lập trình để viết API. Có nhiều ngôn ngữ phổ biến được sử dụng cho việc phát triển API như Python, JavaScript, Ruby, hoặc Java. Hãy chọn một ngôn ngữ mà bạn cảm thấy thoải mái và quen thuộc.
• Kiến thức về HTTP: API là một phương thức để truyền thông tin giữa các ứng dụng. Do đó, hiểu về giao thức HTTP (Hypertext Transfer Protocol) là rất quan trọng. Hãy tìm hiểu về các phương thức HTTP như GET, POST, PUT, DELETE và các khái niệm như header, body, và status codes.
• Kiến thức về RESTful: REST (Representational State Transfer) là một kiến trúc phổ biến cho việc thiết kế API. Hiểu về các nguyên tắc của RESTful như các phương thức CRUD (Create, Read, Update, Delete), cách quản lý state và các đường dẫn (URL) trong API.
• Cơ sở dữ liệu: Đa số các API liên quan đến việc lưu trữ và truy xuất dữ liệu. Nên hiểu về cơ sở dữ liệu, các loại cơ sở dữ liệu phổ biến như MySQL, PostgreSQL, MongoDB và cách thao tác với dữ liệu trong ngôn ngữ lập trình bạn chọn.
• Các framework/API frameworks: Sử dụng một framework/API framework sẽ giúp bạn nhanh chóng xây dựng API. Ví dụ như Flask hoặc Django cho Python, Express cho JavaScript, Ruby on Rails cho Ruby, Spring cho Java. Nên tìm hiểu về cách sử dụng framework/API framework và các khái niệm như routing, middleware, validation, và authentication.
• Hiểu về mã nguồn mở (open source): Có thể học từ các dự án mã nguồn mở có sẵn để hiểu cách các API đã được xây dựng và triển khai. Bạn có thể khám phá các mã nguồn dự án phổ biến trên GitHub hoặc GitLab.
• Kiến thức về bảo mật: Bảo mật là một phần quan trọng trong việc phát triển API. Hiểu về các phương pháp bảo mật như xác thực (authentication) và ủy quyền (authorization), HTTPS, SQL injection, cross-site scripting (XSS) và cross-site request forgery (CSRF).
• Tìm hiểu và thực hành: Cuối cùng, hãy đọc sách, tài liệu trực tuyến, và thực hành viết API. Tìm hiểu từ các nguồn đáng tin cậy như tài liệu chính thức của framework/API framework mà bạn chọn và các bài viết hướng dẫn từ các chuyên gia.

Việc học viết API đòi hỏi sự kiên nhẫn và thực hành. Bắt đầu bằng việc xây dựng những API đơn giản và từ đó, mở rộng kiến thức và kỹ năng của bạn.

Ví dụ minh hoạ

Ví dụ đơn giản để viết một API để lấy giá trị “3.6T” từ câu lệnh “df -h | grep 192.168.13.228:/volumes-hdd | awk ‘{print $2}'”, bạn có thể sử dụng một ngôn ngữ lập trình như Python và framework như Flask để xây dựng API. Dưới đây là một ví dụ đơn giản:

Cài đặt Flask:

pip install flask

Tạo một file có tên app.py và thêm nội dung sau:

from flask import Flask

app = Flask(__name__)

@app.route('/api/volume', methods=['GET'])
def get_volume():
    import subprocess
    
    command = "df -h | grep 192.168.13.228:/volumes-hdd | awk '{print $2}'"
    output = subprocess.check_output(command, shell=True)
    volume_size = output.decode('utf-8').strip()
    
    return volume_size

if __name__ == '__main__':
    app.run(debug=True)

Lưu và chạy file app.py:

python app.py

Sau khi chạy, API của bạn sẽ sẵn sàng để lấy giá trị “3.6T”. Bạn có thể truy cập API bằng đường dẫn http://localhost:5000/api/volume (thay đổi tùy thuộc vào cấu hình máy chủ của bạn).

Nếu việc chạy câu lệnh shell từ một ứng dụng web được coi là không an toàn, bạn có thể sử dụng các giải pháp thay thế như sau:

• Sử dụng thư viện Python thay vì câu lệnh shell: Thay vì chạy câu lệnh shell, bạn có thể sử dụng các thư viện Python để thực hiện chức năng tương tự mà câu lệnh shell đang thực hiện. Ví dụ, thay vì sử dụng câu lệnh shell df -h | grep 192.168.13.228:/volumes-hdd | awk '{print $2}', bạn có thể sử dụng thư viện psutil để lấy thông tin về dung lượng ổ đĩa. Dưới đây là một ví dụ:

import psutil

def get_volume_size():
    mount_point = '/volumes-hdd'
    partitions = psutil.disk_partitions(all=True)
    
    for partition in partitions:
        if partition.mountpoint == mount_point:
            usage = psutil.disk_usage(partition.mountpoint)
            return f"{usage.total / (1024**4):.1f}T"

    return None

Truy vấn đến dữ liệu từ hệ thống quản lý cơ sở dữ liệu: Nếu thông tin về dung lượng ổ đĩa được lưu trữ trong cơ sở dữ liệu, bạn có thể sử dụng thư viện truy vấn cơ sở dữ liệu để lấy thông tin đó thay vì chạy câu lệnh shell. Ví dụ, nếu bạn đang sử dụng cơ sở dữ liệu MySQL, bạn có thể sử dụng thư viện mysql-connector-python để truy vấn dữ liệu từ bảng tương ứng.

import mysql.connector

def get_volume_size():
    connection = mysql.connector.connect(
        host="localhost",
        user="yourusername",
        password="yourpassword",
        database="yourdatabase"
    )

    cursor = connection.cursor()
    query = "SELECT volume_size FROM volumes WHERE ip_address = '192.168.13.228'"
    cursor.execute(query)
    result = cursor.fetchone()

    if result:
        return result[0]

    return None

Lưu ý rằng cách thực hiện cụ thể sẽ phụ thuộc vào ngữ cảnh và yêu cầu của ứng dụng của bạn. Hãy cân nhắc sử dụng các thư viện chính thức và xử lý đầu vào người dùng một cách an toàn để đảm bảo tính bảo mật và tránh các lỗ hổng.

Nếu bạn muốn thay thế MySQL bằng MongoDB để truy vấn dữ liệu từ ổ đĩa trong trường hợp này, bạn có thể sử dụng thư viện MongoDB Connector for Python để kết nối và truy vấn dữ liệu. Dưới đây là một ví dụ:

Cài đặt thư viện MongoDB Connector for Python:

pip install pymongo

Kết nối tới cơ sở dữ liệu MongoDB và truy vấn dữ liệu:

import pymongo

def get_volume_size():
    client = pymongo.MongoClient("mongodb://localhost:27017/")
    db = client["yourdatabase"]
    volumes_collection = db["volumes"]
    
    query = {"ip_address": "192.168.13.228"}
    volume = volumes_collection.find_one(query)
    
    if volume:
        return volume["volume_size"]
    
    return None

Lưu ý rằng trong ví dụ này, bạn cần thay đổi các thông số như địa chỉ của MongoDB (localhost:27017), tên cơ sở dữ liệu (yourdatabase), và tên bảng (volumes) để phù hợp với cấu hình MongoDB của bạn.

Đảm bảo bạn đã cài đặt và cấu hình MongoDB đúng cách trước khi sử dụng thư viện này.