Cách truyền nhiều tham số trong URL của REST API

URL REST API là những thành phần quan trọng trong dịch vụ web. Nếu không có chúng, các trang web sẽ rất khó để định vị các tài nguyên trong các bộ sưu tập. Về cơ bản, chúng cho phép các trang web thay đổi hiển thị của mình theo mong muốn của người dùng.

Để có sự hiểu biết vững chắc về cách truyền nhiều tham số trong một URL REST API, trước tiên chúng ta hãy hiểu rõ tiền đề của câu hỏi này.

Tham số là gì?

Tham số là những đoạn thông tin được gắn vào URL, cung cấp thêm chi tiết về một tài nguyên hoặc hành động được yêu cầu. Nó cũng có thể được coi là một lớp bộ lọc bổ sung cho các trang web.

Tham số được sử dụng ở đâu?

Có nhiều tình huống thực tế mà tham số được truyền trong các URL REST API. Đây là một vài kịch bản chính mà bạn có thể dễ dàng thấy tham số đang hoạt động:

• REST API: Tham số xác định biến thể của tài nguyên, lọc dữ liệu hoặc kiểm soát hành động.
• Các công cụ tìm kiếm: Tham số được sử dụng để tinh chỉnh truy vấn tìm kiếm hoặc theo dõi giới thiệu.
• Các trang web thương mại điện tử: Để lọc sản phẩm, quản lý giỏ hàng hoặc theo dõi các chiến dịch.
• Các nền tảng mạng xã hội: Để cá nhân hóa nội dung hoặc kích hoạt các hành động cụ thể.

Các Loại Tham Số Chung để Truyền Tham Số trong URL REST API

Thông thường, có hai loại tham số mà chúng ta có thể sử dụng để truyền trong URL REST API.

Tham số Truy vấn

Tham số truy vấn là loại tham số được thêm vào sau dấu hỏi ( ? ). Thông thường, tham số truy vấn xuất hiện dưới dạng cặp khóa-giá trị được phân tách bởi dấu "=" ( = ), và mỗi cặp khóa-giá trị liên kết với nhau bằng dấu "&" ( & ).

Một URL REST API mà bạn có thể quan sát thấy tham số truy vấn được truyền vào là:

https://api.example.com/users?id=123&name=John%20Appleseed

Các cặp tham số khóa-giá trị mà chúng ta có thể thấy là:

• id với giá trị là 123.
• name với giá trị là John Appleseed.

Tham số Đường dẫn

Tham số đường dẫn là một loại tham số URL khác thường được truyền trong các URL REST API. Những tham số này được sử dụng để xác định và truy cập vào các tài nguyên cụ thể trong hệ thống đó.

Cách xuất hiện và cấu trúc của tham số đường dẫn khác với tham số truy vấn, và chức năng của chúng cũng khác một chút. Tham số đường dẫn có nhiều khả năng được sử dụng để xác định duy nhất một tài nguyên cụ thể trong một bộ sưu tập.

Một ví dụ về tham số đường dẫn sẽ là:

Với placeholder: https://api.example.com/blog/posts/{post_id}

Không có placeholder: https://api.example.com/blog/posts/123

Như chúng ta có thể thấy, tham số đường dẫn sử dụng cấu trúc placeholder (trong ví dụ này là {post_id}), nơi giá trị thực tế được thay thế.

Bạn thậm chí có thể kết hợp nhiều tham số đường dẫn để xác định các tài nguyên cụ thể hơn trong hệ thống của bạn. Một ví dụ phức tạp hơn để truyền tham số trong một URL REST API sẽ là:

https://api.example.com/users/{user_id}/posts/{post_id}

Chừng nào bạn có các giá trị thực sự để thay thế các placeholder tìm thấy trong URL, bạn có thể thay đổi hiển thị của trang web của mình. Nếu bạn để ý, việc sử dụng tham số đường dẫn cũng tạo ra các URL REST API dễ đọc hơn.

Các Bước Cần Thực Hiện Để Truyền Tham Số Trong URL REST API

Hãy dành thời gian suy nghĩ về việc URL REST API được sử dụng để làm gì, hoặc bạn muốn tạo URL REST API của mình như thế nào, vì các trang web khác nhau có xu hướng có các nhu cầu khác nhau, do đó bạn có thể thích một loại tham số hơn loại khác.

Nếu bạn dự định xây dựng một trang web năng động hơn, hoặc các tham số của bạn thường là tùy chọn, thì bạn có thể xem xét sử dụng tham số truy vấn.

Tuy nhiên, bạn nên chọn tham số đường dẫn nếu bạn thấy mình liên tục cần phải đề cập đến các tham số này để truy cập vào một số tài nguyên nhất định từ hệ thống của bạn.

Hơn nữa, bạn nên làm quen với các phương pháp tốt nhất để tạo URL REST API, vì có một số điểm cần lưu ý mà bạn có thể chưa biết hoặc chưa nghe nói đến trước đây.

Apidog - Nền Tảng Phát Triển REST API

Apidog là một nền tảng phát triển API theo thiết kế đầu tiên với giao diện người dùng thanh lịch và gọn gàng. Giao diện đơn giản và rõ ràng của nó cho phép điều hướng và sửa đổi API dễ dàng khi cần thiết.

Apidog cũng có khả năng nhập các REST API, sửa đổi các URL REST API và kiểm tra các URL. Để tìm hiểu cách vận hành Apidog để sửa đổi REST API của bạn, hãy tiếp tục đọc phần bên dưới.

Cấu Hình URL REST API, Phương Thức và Điểm Cuối Sử Dụng Apidog

Bạn có thể xây dựng riêng các API của mình bằng cách sử dụng Apidog, cũng như thực hành những gì bạn đã học về việc truyền nhiều tham số trong các URL REST API!

Mũi tên 1 - Bạn có thể bắt đầu bằng cách tạo một URL REST API cho yêu cầu của mình. Hãy chắc chắn rằng không có lỗi chính tả để bạn có thể nhận được phản hồi! Bạn cũng có thể xác định số lượng tham số và loại tham số mà bạn muốn bao gồm.

Arrow 2 - Quyết định phương thức REST API mà bạn muốn. Các phương thức phổ biến nhất là GET, POST, PUT và DELETE. Tuy nhiên, hãy lưu ý rằng mỗi phương thức có thể yêu cầu tham số và ID trong URL.

Arrow 3 - Giải thích chi tiết về REST API bằng cách bao gồm các tham số yêu cầu, các tham số phản hồi và các phản hồi ví dụ dưới đây. Rất được khuyến nghị để mọi thứ được điền đầy đủ vì mọi biến sẽ được bao gồm trong tài liệu API.

Kiểm Tra Các Điểm Cuối API (hoặc URL API) Với Apidog

Sau khi tạo REST API của bạn, bạn có thể kiểm tra xem URL REST API mà bạn tạo có thành công hay không. Bạn nên có thể thấy màn hình của mình với điều gì đó tương tự như hình dưới đây:

Apidog hỗ trợ kiểm tra hầu hết các loại điểm cuối API, bao gồm API SOAP và GraphQL. (Trong hình trên, API được hiển thị là API SOAP.)

Đầu tiên, hãy chọn các yêu cầu REST API của bạn có sẵn ở bên phải màn hình, như được chỉ ra bởi Mũi tên 1.

Sau đó, bạn có thể gửi yêu cầu bằng cách nhấp vào nút được chỉ ra bởi Mũi tên 2, nhưng hãy đảm bảo rằng bạn đã chọn đúng môi trường hoặc bao gồm đúng URL yêu cầu API.

Cuối cùng, hãy đến phần phản hồi để xem phản hồi nhận được sau khi gửi yêu cầu, và kiểm tra xem nó có giống như những gì mong đợi hay không.

Kết Luận

Truyền nhiều tham số trong một URL REST API sẽ trở thành một phần phổ biến trong quy trình phát triển web của bạn. Khi trang web và cơ sở dữ liệu của bạn phát triển, chiều dài và độ phức tạp của URL REST API của bạn cũng sẽ tăng lên, do đó không bao giờ quá sớm để bắt đầu làm quen với khái niệm này.

Nếu bạn cần một nền tảng phát triển API để thực hành tạo các URL REST API với nhiều tham số, bạn luôn có thể xem xét việc sử dụng Apidog. Apidog cũng tạo điều kiện cho nhiều sửa đổi và thông số cho toàn bộ vòng đời của một API, vì vậy hãy thử ngay bây giờ!