Cách thực hiện lệnh gọi API REST từ bên trong mã VS
Trong quá trình phát triển, bạn thường đưa ra các yêu cầu đối với API. Đây có thể là một số API bên ngoài hoặc API của máy chủ phụ trợ của riêng bạn.
Bạn có thể sử dụng các công cụ của bên thứ ba như Postman để thực hiện lệnh gọi API của mình. Nhưng tiện ích mở rộng Mã VS cho phép bạn thực hiện lệnh gọi API ngay từ bên trong Mã VS. Tại đây, bạn sẽ tìm hiểu cách thực hiện các yêu cầu API trong Mã VS.
Mục Lục
Tiện ích mở rộng ứng dụng khách REST của mã VS
Tiện ích mở rộng trong Mã VS là một plugin hoặc tiện ích bổ sung giúp tăng cường các chức năng của trình soạn thảo Visual Studio Code. Thị trường tiện ích mở rộng Mã VS cung cấp một số loại tiện ích mở rộng có thể giúp bạn thực hiện các tác vụ lập trình của mình. Có một phần mở rộng để thêm hỗ trợ ngôn ngữ. Có một cái để cung cấp tính năng tự động hoàn thành cho một ngôn ngữ lập trình cụ thể, v.v. Tiện ích mở rộng giúp lập trình dễ dàng hơn với VS Code.
Tiện ích mở rộng Máy khách REST cho phép bạn thực thi các yêu cầu API từ bên trong Mã VS. Tiện ích mở rộng bao gồm trình chỉnh sửa API REST, một giao diện trực quan cho phép bạn truy vấn các điểm cuối API. Nó chấp nhận tiêu đề tùy chỉnh, tham số truy vấn và một số tham số khác.
Để cài đặt Máy khách REST, hãy mở Mã VS và nhấp vào Tiện ích mở rộng chuyển hướng. Tìm kiếm Máy khách REST và nhấp vào Cài đặt để thêm nó vào Mã VS.
Bên dưới Chi tiết tab, bạn sẽ tìm thấy hướng dẫn hữu ích về cách sử dụng ứng dụng khách để thực hiện các yêu cầu API. Hãy xem bốn loại yêu cầu phổ biến và cách tạo chúng bằng tiện ích mở rộng Máy khách REST.
Chúng tôi sẽ sử dụng JSONPlaceholder để minh họa việc thực hiện lệnh gọi API bằng tiện ích mở rộng Máy khách REST. Nó cung cấp sáu tài nguyên phổ biến mà bạn có thể đọc, chỉnh sửa, cập nhật hoặc xóa bằng cách thực hiện các yêu cầu API.
Thực hiện yêu cầu GET bằng tiện ích mở rộng ứng dụng khách REST
Bắt đầu bằng cách tạo một .http tệp cho các yêu cầu API của bạn. Bạn có thể đặt tên cho tập tin myrequest.http.
Thêm đoạn mã sau vào của bạn myrequest.http tệp để truy xuất tài nguyên từ JSONPlaceholder API có 1 làm ID của nó:
GET https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Để gửi yêu cầu, hãy nhấp vào Gửi yêu cầu nút xuất hiện ở đầu tệp. Một cửa sổ mới sẽ mở ra chứa các chi tiết phản hồi.
Đây là cách bạn thực hiện yêu cầu NHẬN bên trong Mã VS.
Thực hiện yêu cầu POST bằng tiện ích mở rộng ứng dụng khách REST
Bạn tạo một yêu cầu POST khi bạn muốn đăng dữ liệu lên máy chủ, thường là để tạo một tài nguyên mới.
Để tạo tài nguyên mới trong API JSONPlaceholder, hãy thay thế mã trong myrequest.http tập tin với nội dung sau:
POST https://jsonplaceholder.typicode.com/posts HTTP/1.1
Content-Type: "application/json"{
"title": "foo",
"body": "bar",
"userId": 1
}
Nhấn vào Gửi yêu cầu để gửi yêu cầu. Một lần nữa, thao tác này sẽ mở ra một cửa sổ mới chứa dữ liệu phản hồi. Câu trả lời cho thấy một HTTP/1.1 201 được tạo thông báo và ID của bài đăng cùng với dữ liệu khác nếu lệnh gọi API thành công.
{
"id": "101"
}
Thực hiện yêu cầu PUT bằng tiện ích mở rộng ứng dụng khách REST
Bạn thực hiện yêu cầu PUT khi muốn cập nhật dữ liệu trên máy chủ.
Để cập nhật tài nguyên hiện có trong API JSONPlaceholder, hãy thay thế mã trong myrequest.http tập tin với nội dung sau:
PUT https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Content-Type: "application/json"{
"title": "new foo",
"body": "new bar",
"userId": 1
}
Sau khi gửi yêu cầu, tài nguyên sẽ được cập nhật trên máy chủ giả và bạn sẽ nhận được một HTTP/1.1 200 OK tin nhắn.
Thực hiện yêu cầu PATCH bằng tiện ích mở rộng ứng dụng khách REST
Bạn thực hiện một yêu cầu PATCH khi bạn muốn sửa đổi một trường hoặc thuộc tính cụ thể của một tài nguyên nhất định trên máy chủ.
Để chỉ cập nhật tiêu đề của tài nguyên hiện có trong máy chủ giả, hãy thay thế mã trong myrequest.http tập tin với nội dung sau:
https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Content-Type: "application/json"{
"title": "another foo"
}
Sau khi bạn thực hiện yêu cầu, tiêu đề tài nguyên sẽ được cập nhật trên máy chủ giả và bạn sẽ nhận được một HTTP/1.1 200 OK tin nhắn cùng với các dữ liệu khác của tài nguyên.
Thực hiện yêu cầu XÓA bằng tiện ích mở rộng ứng dụng khách REST
Bạn tạo một yêu cầu DELETE khi bạn muốn xóa một tài nguyên trên máy chủ.
Để xóa tài nguyên hiện có trong máy chủ giả, hãy thay thế mã trong myrequest.http tập tin với nội dung sau:
DELETE https://jsonplaceholder.typicode.com/posts/1 HTTP/1.1
Ở đây, Loại nội dung không bắt buộc và đối tượng dữ liệu cũng vậy. Nếu bạn gửi yêu cầu và xóa tài nguyên thành công, bạn sẽ nhận được một HTTP/1.1 200 OK phản ứng với một đối tượng trống.
Thực hiện lệnh gọi API ngay từ bên trong Mã VS
Trước đây, bạn có thể đã sử dụng các công cụ của bên thứ ba như Postman để thực hiện các yêu cầu API. Mặc dù các công cụ này hoạt động tốt nhưng cần có thời gian để thiết lập chúng. Ví dụ: bạn cần có tài khoản Postman để sử dụng trình khám phá API.
Mặc dù có một số công cụ kiểm tra API trực tuyến nhưng với các tiện ích mở rộng như REST Client, việc kiểm tra API sẽ nhanh hơn và dễ dàng hơn rất nhiều. Bạn có thể kiểm tra bất kỳ API nào ngay từ bên trong trình chỉnh sửa VS Code của mình. Điều này đặc biệt hữu ích nếu bạn đang phát triển API cục bộ và muốn thử nghiệm API cục bộ của mình một cách nhanh chóng.
Thử nghiệm API khác Phần mở rộng mã VS
Rest Client rất dễ sử dụng. Tuy nhiên, nó không phải là tiện ích mở rộng Mã VS duy nhất để thử nghiệm API. Các tùy chọn phổ biến khác là Thunder Client, httpYak và httpBook.
Thunder Client cung cấp trình chỉnh sửa API trực quan để đơn giản hóa các yêu cầu API. Tất nhiên, bạn cần biết REST API là gì để sử dụng các công cụ này.