Công cụ Kiểm tra API

Công cụ kiểm tra API là một công cụ miễn phí, dựa trên trình duyệt để kiểm tra các điểm cuối REST API ngay lập tức. Gửi các yêu cầu HTTP với các phương thức tùy chỉnh, tiêu đề, xác thực và nội dung yêu cầu — sau đó kiểm tra trạng thái phản hồi, thời gian, tiêu đề và nội dung được định dạng. Không cần cài đặt hoặc đăng ký. Tất cả các yêu cầu được gửi trực tiếp từ trình duyệt của bạn, giữ cho dữ liệu của bạn ở chế độ riêng tư.

Công cụ kiểm tra API là gì?

Một công cụ kiểm tra API (còn được gọi là API client hoặc REST client) là một công cụ cho phép các nhà phát triển và người kiểm thử gửi các yêu cầu HTTP đến các điểm cuối web API và kiểm tra các phản hồi. Nó rất cần thiết cho việc phát triển API, gỡ lỗi, kiểm tra tích hợp và xác minh tài liệu. Không giống như các ứng dụng máy tính để bàn đầy đủ tính năng như Postman hay Insomnia, công cụ kiểm tra API trực tuyến này không yêu cầu cài đặt — chỉ cần mở trang và bắt đầu kiểm tra.

Các phương thức HTTP được hỗ trợ

Các tính năng chính

• Nhiều phương thức HTTP: Hỗ trợ các yêu cầu GET, POST, PUT, PATCH và DELETE để bao quát tất cả các hoạt động REST API.
• Tiêu đề tùy chỉnh: Thêm bất kỳ số lượng tiêu đề yêu cầu nào với trình chỉnh sửa khóa-giá trị động. Bật/tắt các tiêu đề riêng lẻ mà không cần xóa chúng.
• Hỗ trợ xác thực: Hỗ trợ tích hợp cho xác thực Bearer Token, Basic Auth và API Key — không cần phải xây dựng tiêu đề Authorization theo cách thủ công.
• Trình chỉnh sửa nội dung yêu cầu: Gửi nội dung yêu cầu JSON, XML, mã hóa biểu mẫu hoặc văn bản thuần túy với tiêu đề Content-Type phù hợp được thiết lập tự động.
• Trình xem phản hồi: Xem mã trạng thái phản hồi, thời gian phản hồi, kích thước phản hồi, tiêu đề và nội dung phản hồi được định dạng với làm nổi bật cú pháp JSON.
• Lịch sử yêu cầu: Tự động lưu 30 yêu cầu cuối cùng của bạn với mã trạng thái và thời gian. Nhấp vào bất kỳ mục lịch sử nào để phát lại ngay lập tức.
• Nhập/Xuất cURL: Nhập các lệnh cURL từ tài liệu hoặc xuất yêu cầu của bạn dưới dạng lệnh cURL để chia sẻ hoặc sử dụng trong các tập lệnh.
• 100% Phía khách hàng: Tất cả các yêu cầu được gửi trực tiếp từ trình duyệt của bạn. Các API keys, tokens và dữ liệu của bạn không bao giờ chạm tới máy chủ của chúng tôi.

Cách sử dụng công cụ này

1. Nhập URL API: Nhập hoặc dán URL điểm cuối API đầy đủ vào trường URL (ví dụ: https://jsonplaceholder.typicode.com/posts/1).
2. Chọn phương thức HTTP: Chọn GET, POST, PUT, PATCH hoặc DELETE từ menu thả xuống dựa trên thao tác bạn muốn thực hiện.
3. Thêm tiêu đề và nội dung: Tùy chọn thêm tiêu đề yêu cầu (như Authorization hoặc Content-Type) trong tab Tiêu đề, và nội dung yêu cầu trong tab Nội dung cho các yêu cầu POST/PUT/PATCH.
4. Gửi yêu cầu: Nhấp vào nút Gửi (hoặc nhấn Enter) để thực thi yêu cầu. Công cụ sẽ hiển thị phản hồi với mã trạng thái, thời gian, tiêu đề và nội dung đã được định dạng.
5. Phân tích phản hồi: Xem lại mã trạng thái phản hồi (được mã hóa màu), thời gian phản hồi, kích thước, tiêu đề và nội dung. Các phản hồi JSON được tự động định dạng và làm nổi bật cú pháp.

Các trường hợp sử dụng phổ biến

Phát triển và gỡ lỗi API

Kiểm tra các điểm cuối API của bạn trong quá trình phát triển để xác minh chúng trả về đúng mã phản hồi, tiêu đề và dữ liệu. Lặp lại nhanh chóng thiết kế API của bạn bằng cách kiểm tra các cấu hình yêu cầu khác nhau.

Kiểm tra tích hợp

Xác minh rằng các API của bên thứ ba mà bạn tích hợp đang phản hồi chính xác. Kiểm tra các luồng xác thực, kiểm tra định dạng phản hồi và xác thực xử lý lỗi trước khi viết mã tích hợp.

Xác minh tài liệu API

Xác nhận rằng các ví dụ trong tài liệu API thực sự hoạt động như mô tả. Nhập lệnh cURL từ tài liệu và xác minh phản hồi khớp với những gì được ghi trong tài liệu.

Kiểm tra Webhook

Gửi các yêu cầu POST với tải trọng (payload) cụ thể để kiểm tra các điểm cuối webhook. Xác minh rằng trình xử lý webhook của bạn xử lý chính xác các định dạng tải trọng khác nhau.

Hiểu về mã trạng thái HTTP

• 2xx (Thành công): Yêu cầu đã thành công. 200 OK nghĩa là yêu cầu thành công, 201 Created nghĩa là một tài nguyên mới đã được tạo, 204 No Content nghĩa là thành công nhưng không có nội dung phản hồi.
• 3xx (Chuyển hướng): Yêu cầu đã được chuyển hướng. 301 Moved Permanently và 302 Found cho biết tài nguyên đã được di chuyển đến một URL khác.
• 4xx (Lỗi phía khách hàng): Đã có lỗi với yêu cầu. 400 Bad Request nghĩa là dữ liệu không hợp lệ, 401 Unauthorized nghĩa là thiếu xác thực, 403 Forbidden nghĩa là không đủ quyền, 404 Not Found nghĩa là tài nguyên không tồn tại.
• 5xx (Lỗi máy chủ): Máy chủ đã gặp lỗi. 500 Internal Server Error nghĩa là lỗi máy chủ chung, 503 Service Unavailable nghĩa là máy chủ tạm thời không khả dụng.

CORS và kiểm tra API dựa trên trình duyệt

Vì công cụ này chạy trong trình duyệt của bạn, các yêu cầu API phải tuân theo các chính sách CORS (Cross-Origin Resource Sharing). Nếu API đích không bao gồm tiêu đề Access-Control-Allow-Origin, trình duyệt sẽ chặn phản hồi. Hầu hết các API công khai đều hỗ trợ CORS, nhưng các API nội bộ hoặc riêng tư có thể không. Trong trường hợp đó, hãy cân nhắc kiểm tra từ môi trường phụ trợ (backend) hoặc cấu hình máy chủ API để cho phép CORS.

Câu hỏi thường gặp

Công cụ kiểm tra API là gì?

Công cụ kiểm tra API là một công cụ cho phép bạn gửi các yêu cầu HTTP đến các điểm cuối REST API và kiểm tra các phản hồi. Nó giúp các nhà phát triển gỡ lỗi, kiểm tra và xác minh hành vi của API bằng cách hiển thị mã trạng thái phản hồi, tiêu đề, thời gian phản hồi và nội dung phản hồi trong chế độ xem định dạng.

Công cụ kiểm tra API này có miễn phí không?

Có, công cụ kiểm tra API này hoàn toàn miễn phí và không yêu cầu đăng ký. Tất cả các yêu cầu được gửi trực tiếp từ trình duyệt của bạn, vì vậy dữ liệu của bạn được giữ riêng tư và không bao giờ được lưu trữ trên máy chủ của chúng tôi.

Tôi có thể kiểm tra các API yêu cầu xác thực không?

Có. Bạn có thể thêm các tiêu đề Authorization với Bearer tokens, API keys, hoặc thông tin xác thực Basic. Chỉ cần thêm một tiêu đề với khóa "Authorization" và giá trị token của bạn trong phần tiêu đề, hoặc sử dụng tab Auth tích hợp để thuận tiện hơn.

Tại sao yêu cầu API của tôi thất bại với lỗi CORS?

Lỗi CORS (Cross-Origin Resource Sharing) xảy ra khi máy chủ API đích không cho phép các yêu cầu từ trình duyệt web trên các miền khác nhau. Đây là một chính sách bảo mật phía máy chủ. Bạn có thể yêu cầu nhà cung cấp API thêm tiêu đề CORS hoặc sử dụng API từ máy chủ phụ trợ thay thế.

Những phương thức HTTP nào được hỗ trợ?

Công cụ này hỗ trợ năm phương thức HTTP phổ biến nhất: GET để truy xuất dữ liệu, POST để tạo tài nguyên, PUT để thay thế tài nguyên, PATCH để cập nhật một phần và DELETE để xóa tài nguyên.

Tài nguyên bổ sung

• Phương thức yêu cầu HTTP - MDN Web Docs
• Mã trạng thái phản hồi HTTP - MDN Web Docs
• Chia sẻ tài nguyên đa nguồn (CORS) - MDN Web Docs