Working with JSON APIs: A Beginner's Guide — csv-x.com

Tôi vẫn nhớ ngày mà tôi vô tình làm hỏng toàn bộ đường ống dữ liệu của công ty. Đó là năm 2015, tôi đã làm việc được ba tháng tại công việc đầu tiên của mình với tư cách là một lập trình viên mới tại một công ty khởi nghiệp fintech, và tôi vừa đẩy mã mà thực hiện 50.000 yêu cầu API trong chưa đầy hai phút. Giới hạn tốc độ của chúng tôi là 1.000 yêu cầu mỗi giờ. Những cuộc gọi từ nhà cung cấp API của chúng tôi không hề dễ chịu, và cuộc trò chuyện với CTO của tôi cũng không kém phần khó chịu. Khoảnh khắc đáng xấu hổ đó đã dạy tôi nhiều hơn về việc làm việc với JSON APIs hơn bất kỳ hướng dẫn nào có thể, và đó là lý do tôi viết hướng dẫn này hôm nay—để bạn có thể học từ những sai lầm của tôi thay vì phạm phải những sai lầm của chính mình.

Trong chín năm qua với tư cách là một kỹ sư backend và chuyên gia tích hợp API, tôi đã làm việc với hàng trăm JSON APIs khác nhau—từ các dịch vụ thời tiết đơn giản đến các nhà cung cấp dữ liệu tài chính phức tạp. Tôi đã xây dựng các hệ thống xử lý hàng triệu cuộc gọi API mỗi ngày và tôi đã gỡ lỗi các vấn đề tích hợp tốn kém hàng nghìn đô la mỗi giờ downtime. Những gì tôi học được là làm việc với JSON APIs không chỉ là gửi yêu cầu HTTP và phân tích phản hồi. Đó là về việc hiểu giới hạn tốc độ, xử lý lỗi một cách linh hoạt, quản lý xác thực một cách an toàn, và xây dựng các hệ thống có tính chịu lỗi mà không bị sụp đổ khi mọi thứ diễn ra sai lệch.

Hướng dẫn này sẽ dẫn dắt bạn qua mọi thứ bạn cần biết để làm việc tự tin với JSON APIs, cho dù bạn đang xây dựng tích hợp đầu tiên hay muốn nâng cao kỹ năng của mình. Chúng tôi sẽ đề cập đến các nguyên tắc cơ bản, khám phá những cạm bẫy phổ biến, và dấn thân vào các kỹ thuật thực tiễn sẽ giúp bạn trở thành một lập trình viên hiệu quả hơn.

Hiểu Rõ JSON APIs Thực Sự Là Gì

Trước khi chúng ta đào sâu vào các chi tiết kỹ thuật, hãy xác định những gì chúng ta đang thảo luận. JSON API đơn giản là một cách để các ứng dụng phần mềm khác nhau giao tiếp với nhau qua internet bằng cách sử dụng JSON (JavaScript Object Notation) làm định dạng dữ liệu. Hãy nghĩ về nó như một người phục vụ trong một nhà hàng—bạn (khách hàng) đưa ra một yêu cầu cho một cái gì đó cụ thể, người phục vụ mang yêu cầu đó đến bếp (máy chủ), và mang về chính xác những gì bạn đã yêu cầu ở định dạng chuẩn.

JSON đã trở thành định dạng chi phối cho các web API vì nó nhẹ, dễ đọc và được hỗ trợ bởi hầu hết mọi ngôn ngữ lập trình. Khi tôi bắt đầu sự nghiệp của mình, XML vẫn phổ biến, và cho tôi nói—làm việc với JSON thì dễ chịu hơn rất nhiều. Một phản hồi JSON điển hình có thể trông như thế này:

{"user": {"id": 12345, "name": "Sarah Chen", "email": "[email protected]", "created_at": "2024-01-15T10:30:00Z"}}

Sánh nó với phiên bản XML tương đương với tất cả các thẻ mở và đóng của nó, và bạn sẽ hiểu lý do tại sao JSON đã thắng. Nó ngắn gọn, dễ đọc và ánh xạ tự nhiên đến các cấu trúc dữ liệu trong hầu hết các ngôn ngữ lập trình—các đối tượng trong JavaScript, các từ điển trong Python, các bản đồ trong Go, và vân vân.

Hầu hết các JSON APIs hiện đại tuân theo các nguyên tắc REST (Representational State Transfer), có nghĩa là chúng sử dụng các phương thức HTTP tiêu chuẩn như GET (lấy dữ liệu), POST (tạo dữ liệu), PUT hoặc PATCH (cập nhật dữ liệu) và DELETE (xóa dữ liệu). Sự chuẩn hóa này làm cho các API dễ đoán và dễ làm việc hơn. Khi bạn thấy một yêu cầu GET đến /api/users/12345, bạn có thể hợp lý giả định rằng nó đang lấy thông tin về người dùng 12345. Một POST đến /api/users có thể đang tạo một người dùng mới.

Hiểu rõ nền tảng này là rất quan trọng vì nó hình thành cách mà bạn sẽ tương tác với hầu hết mọi API mà bạn gặp. Các mẫu là nhất quán qua các dịch vụ khác nhau, có nghĩa là một khi bạn làm chủ các nguyên tắc cơ bản với một API, bạn có thể áp dụng kiến thức đó cho hàng trăm API khác.

Thực Hiện Yêu Cầu API Đầu Tiên

Hãy thực tế. Cách đơn giản nhất để tương tác với một JSON API là thông qua một công cụ như curl hoặc Postman, nhưng cuối cùng bạn sẽ muốn gửi yêu cầu từ mã của mình. Tôi sẽ cho bạn xem các ví dụ bằng Python vì nó dễ tiếp cận, nhưng các khái niệm áp dụng cho bất kỳ ngôn ngữ nào.

Dưới đây là yêu cầu API cơ bản nhất mà bạn có thể thực hiện:

import requests
response = requests.get('https://api.example.com/users/12345')
data = response.json()
print(data['name'])

Đoạn mã bốn dòng này thực hiện rất nhiều: nó gửi một yêu cầu HTTP GET đến API, nhận phản hồi, phân tích JSON thành một từ điển Python, và trích xuất một trường cụ thể. Đơn giản phải không? Nhưng mã này có ít nhất năm vấn đề nghiêm trọng có thể làm cho nó thất bại trong môi trường sản xuất.

Đầu tiên, không có xử lý lỗi. Điều gì sẽ xảy ra nếu mạng bị ngắt? Điều gì sẽ xảy ra nếu người dùng không tồn tại và API trả về mã 404? Điều gì sẽ xảy ra nếu API tạm thời không khả dụng và trả về mã 503? Mã của bạn sẽ bị sự cố. Thứ hai, không có thời gian chờ được chỉ định. Nếu máy chủ API bị treo, mã của bạn sẽ đợi vô thời hạn. Thứ ba, không có xác thực—hầu hết các API thực tế yêu cầu một hình thức thông tin xác thực nào đó. Thứ tư, không có xem xét việc giới hạn tốc độ. Và thứ năm, không có xác thực rằng phản hồi thực sự chứa dữ liệu bạn mong đợi.

Dưới đây là một phiên bản mạnh mẽ hơn giải quyết những vấn đề này:

import requests
from requests.exceptions import RequestException
import time

def fetch_user(user_id, api_key, max_retries=3):
    url = f'https://api.example.com/users/{user_id}'
    headers = {'Authorization': f'Bearer {api_key}'}
    
    for attempt in range(max_retries):
        try:
            response = requests.get(url, headers=headers, timeout=10)
            response.raise_for_status()
            data = response.json()
            
            if 'name' not in data:
                raise ValueError('Định dạng phản hồi không hợp lệ')
            
            return data
        
        except RequestException as e:
            if attempt == max_retries - 1:
                raise
            time.sleep(2 ** attempt)
    
    return None

Phiên bản này bao gồm xử lý thời gian chờ, xác thực, logic thử lại với thời gian nghỉ theo cấp số nhân, xử lý lỗi và xác thực phản hồi. Nó có nhiều mã hơn, nhưng đó là mã đã sẵn sàng cho sản xuất sẽ không để bạn phải gỡ lỗi những lỗi bí ẩn vào lúc 2 giờ sáng.

Thực Hành Tốt Nhất Về Xác Thực và Bảo Mật

Một trong những sai lầm lớn nhất của tôi khi mới bắt đầu là mã hóa cứng các khóa API trực tiếp trong mã nguồn của tôi. Tôi đã cam kết chúng vào Git, đẩy lên GitHub, và trong vòng vài giờ đã có một bot quét kho lưu trữ của tôi và tích lũy các khoản phí trên tài khoản API của tôi. Tôi đã học về các biến môi trường và quản lý bí mật theo cách khó khăn, với hóa đơn $847 từ một nhà cung cấp đám mây.