Cách sử dụng Postman để kiểm tra API

Một API chuyển một yêu cầu từ ứng dụng phần mềm này sang ứng dụng phần mềm khác, sau đó mang phản hồi từ phần mềm số 2 cho phần mềm số 1. Bởi vậy, nếu API bị lỗi thì ứng dụng sẽ gặp sự cố. Nền tảng Postman giúp bạn duy trì các API của mình với tính năng kiểm tra API, bên cạnh nhiều tính năng hữu ích khác.

1. Postman là gì?

Postman là một nền tảng giúp bạn làm việc với các API. Đây là một kho lưu trữ API, giúp bạn lưu trữ, sắp xếp và sử dụng các API của mình. Kho lưu trữ của Postman dựa trên đám mây và có tính năng kiểm soát các phiên bản (version control). Bởi vậy, đây là nền tảng lý tưởng để phát triển API trên nhiều thiết bị cho cá nhân cũng như cho một team. 

Nền tảng này giúp bạn quản lý mọi khía cạnh của một quy trình phát triển API. Nó này cung cấp mọi thứ cần thiết để test một API CRUD hoàn chỉnh . Một số tính năng phổ biến là:

• Thông số kỹ thuật
• Tài liệu (Documentation)
• Workflow recipes (thư viện workflow được tạo sẵn, thử nghiệm và chứng minh hiệu quả)
• Kiểm thử
• Chỉ số (metrics)

>>> Xem thêm: Bảo mật API là gì? Bảo mật API hoạt động như thế nào?

2. Cài đặt Postman trên thiết bị

Bạn có thể tải ứng dụng trên máy Windows, Apple hoặc Linux từ trang web chính thức của nó. Sau khi bạn chọn loại máy của mình, tệp thực thi sẽ tự động được tải xuống. 

>>> Xem thêm: Hướng dẫn đầy đủ về Bảo mật API cho người trong ngành

3. Cách tạo yêu cầu bằng Postman

Phiên bản mới nhất của nền tảng (v9.28.1) khởi chạy với giao diện như sau:

Để gửi yêu cầu đến một API hiện có, hãy nhấp vào nút New (mới) ở góc trên cùng phía bên trái. Một cửa sổ được bật lên:

Góc trên cùng bên trái của cửa sổ bật lên có tùy chọn để tạo một yêu cầu HTTP cơ bản (basic HTTP request). Chọn nó và giao diện sau sẽ mở ra:

Có một số trường quan trọng trong giao diện. Trường đầu tiên bạn nên để ý đến là trường phương thức yêu cầu (request method). Phương thức yêu cầu mặc định là GET, nhưng có đến hơn 10 phương thức khác nhau để bạn lựa chọn.

Năm phương pháp mà bạn sẽ dùng thường xuyên là:

• GET: lấy dữ liệu từ database.
• POST: thêm dữ liệu mới vào database.
• PUT: cập nhật toàn bộ trường dữ liệu trong database.
• PATCH: cập nhật các khía cạnh cụ thể của một trường dữ liệu trong database.
• DELETE: xóa dữ liệu khỏi database.

Trường URL nằm ngay bên cạnh trường request method. Để kiểm tra một API, bạn chỉ cần chọn request method và cung cấp URL thích hợp.

Kiểm tra API công khai

Ví dụ sau sử dụng một API tin tức tên Newsdata.io. Nó có một số tùy chọn truy vấn trả về tin tức quốc tế. Điểm cuối (endpoint) dựa trên quốc gia có cấu trúc sau:

https://newsdata.io/api/1/news?apikey=YOUR_API_KEY&country=us

Bạn sẽ cần thay thế giá trị YOUR_API_Key trong URL trên bằng khóa API mà bạn nhận được sau khi đăng ký với Newsdata.io. Chèn URL đã cập nhật vào Postman và bạn sẽ thaays kết quả trả lại như bên dưới.

{
    "status": "success",
    "totalResults": 10173,
    "results": [
        {
            "title": "Apple could be first to use TSMC's 3nm chip process for M2 Pro",
            "link": "https://appleinsider.com/apple-could-be-first-to-use-tsmcs-3nm-chip-process-for-m2-pro?utm_medium=rss",
            "keywords": null,
            "creator": [
                "news@appleinsider.com (Mike Peterson)"
            ],
            "video_url": null,
T            "description": "Apple's 2022 MacBook may pack new M2 Pro and M2 Max chipsets made with TSMC latest 3nm manufacturing process, according to new report. The world's largest semiconductor contract manufacturer M2TSMC has been steadily building out its 3nm production processes. According to Commercial Times, Apple could be the first to get its hands on those chips. Read more...",
            "content": null,
            "pubDate": "2022-08-18 15:22:53",
            "image_url": null,
            "source_id": "appleinsider",
            "country": [
                "united states of america",
                "united kingdom",
                "india",
                "australia",
                "singapore",
                "canada"
            ],
            "category": [
                "technology"
            ],
            "language": "english"
        },
    ],
    "nextPage": 1
}

Postman sẽ trả lại một loạt các tin tức. Kết quả ở trên chỉ hiển thị một tin tức ví dụ. 

>>> Xem thêm: Xác thực API là gì? Xác thực API hoạt động như thế nào?

4. Bây giờ bạn đã có thể kiểm tra API với Postman

Postman là một nền tảng phổ biến để kiểm tra các API mà bạn muốn dùng trong các dự án của mình. Khi bạn đã kiểm tra các API của mình, bước tiếp theo là tích hợp chúng vào các ứng dụng của bạn.

>>> Bài viết liên quan:

API là gì? API mở đang thay đổi Internet như thế nào?

8 phương pháp hay nhất để thiết kế REST API

7 phương pháp hay nhất để bảo mật REST API: Xác thực và ủy quyền

Vân Nguyễn

Dịch từ: https://www.makeuseof.com/postman-api-test-how-use/