Một cách thích hợp để làm một phương pháp tìm kiếm RESTful phức tạp là gì?

Theo nguyên tắc REST, tôi muốn tạo phương thức GET cho API của mình để thực hiện tìm kiếm bằng một số tiêu chí và trả về kết quả cho khách hàng. Vấn đề là các tiêu chí có thể có tối đa 14 tham số, một trong số đó là danh sách các đối tượng phức tạp, vì vậy ...

• Tôi thậm chí không biết liệu có thể mã hóa / giải mã các đối tượng phức tạp này thành / từ các tham số url hay không.

• Tôi không tính được url có thể nhận được bao lâu nhưng tôi chắc chắn nó sẽ đủ lớn và có thể đạt đến giới hạn chiều dài url?

Ngoài ra, tìm kiếm sẽ hiển thị kết quả theo "thời gian thực", ý tôi là, mỗi khi người dùng thay đổi thứ gì đó từ mẫu tìm kiếm, anh ta sẽ có thể thấy kết quả mới mà không cần nhấn bất kỳ nút "tìm kiếm" nào.

Bạn có thể làm rõ cho tôi những điểm này và lời khuyên của bạn là gì để tạo ra một phương pháp tìm kiếm yên tĩnh với nhiều tham số?

Trước khi bạn đọc câu trả lời của tôi, tôi muốn nói rằng tôi đã đồng ý với @Neil. Chúng tôi phải chọn các trận chiến của chúng tôi. Chúng tôi thường muốn làm hết sức mình, nhưng đôi khi có quá ít chỗ để thảo luận và chúng tôi phải đưa ra quyết định trái với ý muốn của chúng tôi.

Dù sao, trong câu trả lời của Neil, tôi bỏ lỡ một điều nữa. Tài liệu . Chỉ để đảm bảo rằng các nhà phát triển biết rằng các yêu cầu POST /searchđược an toàn.

Mà nói.

1. Cho một cơ hội để NHẬN

Hãy xem xét GETlựa chọn đầu tiên. Kiểm tra độ dài tối đa của URL câu hỏi này . Đánh giá xem chuỗi truy vấn dài nhất của bạn có dài hơn 2000 ký tự hay không. Nếu không, và bạn không mong đợi nó xảy ra, hãy đi cùng GET. Nó có vẻ xấu, nhưng ít nhất bạn có thể đánh dấu URL và tất nhiên, nó có tất cả các lợi thế xuất phát từ ngữ nghĩa của phương thức (idempotence, an toàn và bộ nhớ đệm)

1.1 Thử mã hóa chuỗi truy vấn

Ví dụ: trong cơ sở 64. Ngay cả javascript cũng hỗ trợ mã hóa cơ sở 64 .

Đây là cách nó hoạt động:

1. Xây dựng JSON với tất cả các bộ lọc và chuẩn hóa nó.
2. Phân tích nó thành chuỗi
3. Mã hóa nó
4. Gửi JSON được mã hóa theo yêu cầu param ( /search?q=SGVsbG8gV29ybGQh....).
5. Về phía máy chủ, giải mã param q .
6. Giải nén chuỗi JSON

Trước đây, tạo chuỗi JSON dài nhất có thể, mã hóa nó và lấy độ dài. Đánh giá nếu chuỗi được mã hóa phù hợp với URL. Tôi đã triển khai đoạn mã sau trên Fiddle.js để bạn kiểm tra. (Tôi hy vọng nó vẫn hoạt động) ¹

Mã hóa cơ sở 64 có tính xác định và có thể đảo ngược, do đó không có cơ hội va chạm.

Với các truy vấn được mã hóa, chúng tôi cũng có thể lưu các tìm kiếm trong DB, đánh dấu URL, chia sẻ liên kết, v.v. Và tất nhiên, chúng tôi không phải thoát / hủy bỏ chuỗi.

1.2 Thử với bí danh

Đọc blog này về cách thiết kế API REST, tôi nhớ thêm một lựa chọn khác. Bí danh cho các truy vấn phổ biến .

Tôi thấy những điều này là thú vị cho những lý do tiếp theo

• Rút ngắn độ dài chuỗi truy vấn. Nó làm cho API sạch hơn và thân thiện với người dùng

  NHẬN / vé /? Status = đã đóng & đã đóngAt = xxx so với GET / vé / gần đây đã đóng /

• Kết hợp với nhiều bí danh hoặc nhiều tham số yêu cầu hơn.

  NHẬN / vé /? Status = đã đóng & đã đóngAt = xxx & trong vòng = 30 phút so với NHẬN / vé / gần đây đã đóng /? Trong vòng = 30 phút

• Chúng ta có thể kết hợp bí danh với các chuỗi truy vấn được mã hóa

  NHẬN / vé /? Status = đã đóng & đã đóngAt = xxx & trong vòng 30 phút so với NHẬN / vé / đã đóng gần đây /? Q = SGVsbG8g ...

^{1: Tôi đã sử dụng JSON, nhưng chúng tôi có thể sử dụng các định dạng khác ngay khi chúng tôi có thể giải tuần tự hóa nó ở phía máy chủ.}

Nếu tất cả những gì bạn có là một cái búa, mọi thứ trông giống như một cái đinh. Có vẻ như vấn đề ở đây là bạn đang cố gắng biến một trang tìm kiếm thành một trang RESTful và điều này dường như khó có thể là một mô hình chung cho thiết kế RESTful để giải quyết.

Chỉ cần đi với một yêu cầu POST với các tham số do người dùng cung cấp để có được thông tin bạn yêu cầu từ phụ trợ. Tôi cho rằng bạn không cần phải làm gì ngoài việc thực hiện tìm kiếm, vì vậy không có cơ hội bạn sẽ cần phải chèn qua trang này. Chỉ cần thêm một / tìm kiếm vào cuối URL của bạn để bạn không gặp rủi ro khi xung đột với trang / người dùng của bạn sẽ là RESTful.

Nó hoàn toàn phụ thuộc vào mô hình API của bạn là gì: Không có hoặc dưới dạng động từ.

Nếu API là không có thì bạn có thể muốn lấy danh sách các đối tượng như sau:

GET: /api/v1/objects

Trong trường hợp này, bạn phải gửi dữ liệu dưới dạng tham số yêu cầu. Vì vậy, bạn phải mô tả các tham số của mình dưới dạng một danh sách phẳng các giá trị khóa:

GET: /api/v1/objects

key1 : val1
key2.key1 : val 21
key2.key2 : val 22
....

Một số nền tảng hỗ trợ trình phân giải tham số tùy chỉnh (ví dụ Spring MVC), bạn có thể chuyển đổi các tham số thành một đối tượng.