Triển khai Chuỗi Truy vấn Trong URL API của Bạn Ngày Hôm Nay

Bất cứ khi nào gõ một URL trang web, bạn có nhận thấy bất kỳ sự thay đổi nào không? Đôi khi, khi chuyển qua các trang web khác nhau, chiều dài của URL thay đổi. Tuy nhiên, có những lúc các ký hiệu bổ sung như dấu chấm hỏi ( ? ) và dấu và (& ) xuất hiện. Bạn đã bao giờ tự hỏi chúng có thể có ý nghĩa gì không?

💡

Apidog là một công cụ phát triển API tuyệt vời cho những người muốn có một giao diện người dùng đơn giản và sang trọng để xây dựng, thử nghiệm, giả lập, và tài liệu cho các API. Về cơ bản, họ hỗ trợ bất kỳ chức năng nào cho các nhà phát triển để cá nhân hóa các API của họ.

Nếu bạn muốn sáng tạo và thử nghiệm giới hạn cũng như ranh giới của API của mình, hãy lấy Apidog ngay bây giờ bằng cách nhấn nút bên dưới. 👇 👇 👇

button

Query String là gì?

Query string là một phần của URL (địa chỉ web) đi sau dấu hỏi, và hoạt động như thông tin bổ sung cho một URL.

Cấu trúc Query String

Để hình dung một query string, đây là một ví dụ về một URL, được biểu thị bằng các thành phần của nó:

url strucutre — Các thành phần của một URL

Query string là mọi thứ đi sau một dấu hỏi ( ? ) trong một URL. Tuy nhiên, query string tự nó được cấu thành từ các thành phần khác, bao gồm:

Các tham số truy vấn: Một tham số truy vấn đơn lẻ là một cặp khóa-giá trị cá nhân trong query string. Nếu có thể quan sát, bức tranh trong ví dụ trên chỉ ra một tên tham số truy vấn utm_medium và giá trị tham số truy vấn twitter.

Do đó, trong ví dụ, bạn có thể tìm thấy nhiều tham số truy vấn được truyền qua, đó là utm_campaign=sale, utm_medium=social, và utm_source=twitter.
Các dấu phân cách truy vấn: Các dấu phân cách truy vấn là ký hiệu dấu và ( & ) được sử dụng để phân tách các cặp khóa-giá trị tham số truy vấn tương ứng với nhau. Một chỉ dấu tốt cho thấy tài nguyên càng chính xác hơn là khi bạn có thể thấy nhiều ký hiệu dấu và xếp hàng trong một URL.

Chức năng của Query String

Có một vài lý do tại sao query string được sử dụng rộng rãi trong các địa chỉ web.

Tìm kiếm một thứ gì đó: Khi bạn nhập một thuật ngữ tìm kiếm trên một trang web như Google hoặc Amazon, thuật ngữ tìm kiếm được chuyển thành một query string và gửi đến máy chủ. Máy chủ sau đó sử dụng thông tin này để lấy kết quả liên quan.
Lọc hoặc sắp xếp dữ liệu: Các trang web thường cho phép bạn lọc hoặc sắp xếp dữ liệu dựa trên các tiêu chí cụ thể. Thông tin này cũng được truyền qua query string.
Đơn giản: Query string là một phương pháp trực quan và dễ hiểu để truyền tải thông tin từ phía máy khách (trình duyệt của người dùng) đến máy chủ. Chúng dễ đọc và tương đối dễ dàng để xây dựng và sửa đổi. Sự đơn giản này khiến chúng trở nên lý tưởng cho các tình huống không yêu cầu chuyển giao dữ liệu phức tạp.
Chia sẻ và Đánh dấu: Các URL chứa query string dễ dàng được chia sẻ và đánh dấu. Chúng cho phép người dùng lưu một trạng thái hoặc cấu hình cụ thể của một trang web, bao gồm kết quả tìm kiếm, các bộ lọc hoặc tùy chọn sắp xếp. Điều này giúp người dùng dễ dàng quay lại cùng thông tin hoặc kết quả mà không cần nhập lại mọi thứ thủ công, đặc biệt là khi có nhiều tham số truy vấn liên quan.
Bộ nhớ đệm: Các trình duyệt web thường có thể lưu trữ các trang với query strings, cải thiện hiệu suất trang web và trải nghiệm người dùng. Nếu một người dùng truy cập lại một trang với cùng một query string, trình duyệt có thể lấy phiên bản đã lưu thay vì tải lại từ máy chủ, dẫn đến thời gian tải nhanh hơn.

Các loại trang web thường sử dụng Query String

Vì chức năng của chúng, query string thường thấy việc sử dụng lặp lại trên một số trang web, chẳng hạn như:

Công cụ tìm kiếm:

Google, Bing, và Yahoo: Tất cả các công cụ tìm kiếm đều phụ thuộc rất nhiều vào query string để xử lý tìm kiếm của người dùng. Thuật ngữ tìm kiếm tự nó trở thành một cặp khóa-giá trị trong query string, cho phép máy chủ xác định và lấy kết quả liên quan.

Nền tảng Thương mại điện tử:

Amazon, eBay, và Etsy: Query string rất quan trọng trong việc lọc và sắp xếp danh sách sản phẩm trên các nền tảng này. Người dùng có thể chỉ định các tham số như khoảng giá, danh mục, thương hiệu và nhiều hơn nữa, sau đó được dịch thành query string gửi đến máy chủ để tinh chỉnh các sản phẩm hiển thị.

Mạng xã hội:

Facebook, Twitter, và Instagram: Các nền tảng mạng xã hội thường sử dụng query string để xử lý nhiều chức năng khác nhau. Ví dụ, nhấp vào một hashtag có thể kích hoạt một URL với một query string chỉ định hashtag đó, cho phép máy chủ hiển thị các bài viết liên quan. Ngoài ra, query string có thể được sử dụng để quản lý tài khoản người dùng, điều hướng hồ sơ, và lọc nội dung.

Các trang web Tin tức:

CNN, BBC, và The New York Times: Các trang web tin tức có thể tận dụng query string để phân loại và lọc các bài báo tin tức. Người dùng có thể lọc theo ngày, danh mục (ví dụ: thể thao, chính trị), hoặc từ khóa cụ thể trong nội dung tin tức, tất cả được hỗ trợ thông qua query string.

Phân biệt giữa Query Strings tốt và xấu

Có những thực hành để tạo ra các query string tối ưu cho các địa chỉ web. Mặc dù có vẻ như ai đó chỉ ngẫu nhiên dán các từ và ký hiệu lại với nhau, nhưng các nhà phát triển web cũng cần suy nghĩ về cấu trúc của các URL.

Rõ ràng:

Tốt: https://www.example.com/search?q=running+shoes&size=10 (Các thuật ngữ tìm kiếm rõ ràng cho giày thể thao kích thước 10)

Xấu: https://www.example.com/search?p=shoes&f=running&s=10 (Không rõ "p", "f", và "s" đại diện cho điều gì)

Các query string tốt là dễ đoán và tự giải thích. Đừng lòng vòng, hãy thẳng thắn nhất có thể.

Bảo mật:

Tốt: https://www.example.com/account?user_id=12345&token=encrypted_token (Sử dụng một mã thông báo bảo mật thay vì mật khẩu)

Xấu: https://www.example.com/login?username=john&password=password123 (Bao gồm mật khẩu trực tiếp trong query string, điều này không an toàn)

Điều này có thể có phần kỹ thuật hơn, tuy nhiên, bạn không nên bao gồm dữ liệu nhạy cảm như mật khẩu hoặc số tài khoản ngân hàng làm một phần của các địa chỉ web của bạn.

Bảo trì:

Tốt: https://www.example.com/articles?tag=science&page=2 (Các tham số rõ ràng và dễ hiểu)

Xấu: https://www.example.com/articles?t=sci&pg=2 (Sử dụng các chữ viết tắt quá ngắn làm khó khăn cho việc hiểu và bảo trì)

Khi các trang web phát triển và tài nguyên tăng về kích thước và chiều sâu, bạn cần đảm bảo rằng cấu trúc URL hiện tại của bạn có thể duy trì được.

Giải pháp cho tất cả các vấn đề liên quan đến API - Apidog

Apidog là một công cụ phát triển API mạnh mẽ với nhiều chức năng để các nhà phát triển API tận hưởng. Cùng với một giao diện người dùng đơn giản và trực quan, việc điều hướng qua Apidog rất dễ dàng.

simple intuitive api development platform design apidog — Thiết kế trực quan cho phép phát triển API trở nên dễ dàng và thú vị

button

Tạo API với Query Strings

Với Apidog, bạn có thể kiểm tra kiến thức của mình về query strings bằng cách tạo API của riêng bạn! (Hãy tưởng tượng rằng bạn đang xây dựng một REST API.)

build api apidog — Xây dựng API của bạn với Apidog

Đầu tiên, bạn phải xác định loại phương thức HTTP mà REST API của bạn sẽ xoay quanh. Các loại phương thức HTTP phổ biến được sử dụng hiện nay là:

GET: Sử dụng để lấy dữ liệu từ máy chủ.
POST: Sử dụng để gửi dữ liệu đến máy chủ để tạo một tài nguyên mới.
PUT: Sử dụng để cập nhật một tài nguyên đã tồn tại trên máy chủ.
DELETE: Sử dụng để xóa một tài nguyên khỏi máy chủ.

Tại đây, bạn có thể xác định số lượng tham số truy vấn mà bạn muốn bao gồm trong điểm cuối API của mình. Hãy chắc chắn rằng chúng ngắn gọn và dễ dàng. Một tham số truy vấn tốt nên tự giải thích!

Một khi bạn đã bao gồm các chi tiết khác, bạn có thể nhấp vào nút Lưu để lưu tiến trình của bạn trên REST API.

Tạo kịch bản thử nghiệm cho API với Apidog

Khi bạn hài lòng với API mà bạn đã xây dựng trên Apidog, bạn có thể tiếp tục với giai đoạn tiếp theo của vòng đời API: thử nghiệm.

Tại Apidog, bạn có thể kết hợp nhiều API trong một lần thử nghiệm duy nhất, được gọi là kịch bản thử nghiệm. Đây là một chức năng thử nghiệm nhiều bước nhằm mô phỏng các môi trường thực tế.

initialize new test scenario apidog — Khởi tạo một kịch bản thử nghiệm mới trên Apidog

Đầu tiên, xác định nút Thử nghiệm được chỉ ra bởi Mũi tên 1 trong hình trên. Bạn sẽ thấy Kịch bản Thử nghiệm Mới, được chỉ ra bởi Mũi tên 2.

description new test scenario apidog — Điền mô tả cho kịch bản thử nghiệm mới

Bạn sẽ được nhắc với một cửa sổ pop-up này, yêu cầu bạn nhập một vài chi tiết về kịch bản thử nghiệm mới của bạn.

add step new test scenario api apidog — Thêm bước vào kịch bản thử nghiệm

Thêm một bước (hoặc nhiều bước hơn) vào kịch bản thử nghiệm của bạn bằng cách nhấp vào phần Thêm bước.

select import from api soap apidog — Chọn "Nhập từ APIs"

Chọn Nhập từ API từ menu thả xuống.

add soap api web service test case scenario apidog — Thêm tất cả các API vào kịch bản thử nghiệm của bạn

Chọn tất cả các API mà bạn muốn bao gồm trong kịch bản thử nghiệm của bạn. Trong ví dụ trên, API được gọi là NumberConversionSOAP đã được bao gồm.

edit testing environment start run test scenario apidog — Đặt Môi trường thành "Môi trường Thử nghiệm" và nhấn "Chạy" để bắt đầu thử nghiệm

Trước khi nhấn nút Chạy để bắt đầu kịch bản thử nghiệm của bạn, hãy chắc chắn thay đổi môi trường kịch bản thử nghiệm, mà nên là Môi trường Thử nghiệm, như được chỉ ra bởi Mũi tên 1.

Hãy thử nghiệm, và bạn có thể xem liệu API của bạn có thể đáp ứng tất cả các mong đợi của bạn không!

Kết luận

Query strings là một công cụ tuyệt vời cho các nhà phát triển web sử dụng. Chúng cho phép việc truy cập, lọc, và xem các tài nguyên nhất định trở nên dễ dàng và dễ bảo trì.

Khi tạo query strings, luôn nhớ những phẩm chất này:

Rõ ràng
Bảo mật
Bảo trì

Một câu hỏi tốt để tự hỏi bản thân mỗi khi tạo query strings sẽ là: "Các tham số truy vấn của tôi có tự giải thích không?" Nếu câu trả lời của bạn là không, thì đó có thể là dấu hiệu để xem xét lại query string của bạn.

Apidog là một lựa chọn mạnh mẽ cho nhiều công cụ API phổ biến. Nó không chỉ cung cấp nhiều chức năng hơn so với các công cụ khác, Apidog cũng hỗ trợ các loại tệp từ nhiều khách hàng API khác nhau, giúp thay đổi nền tảng API trở nên dễ dàng. Với một giao diện người dùng rõ ràng và trực quan, người dùng mới có thể nhanh chóng thích nghi với việc làm việc với Apidog.