Cách tốt nhất để thiết kế một API REST với nhiều bộ lọc?

Question

Là một dự án lập trình cá nhân, tôi đang làm việc để cạo danh mục khóa học của Đại học và cung cấp dữ liệu dưới dạng API REST. Tôi đã cạo thành công tất cả dữ liệu và lưu trữ nó trong một cơ sở dữ liệu, và bây giờ tôi đang làm việc trên API.

Các khóa học có thể được lọc trên cơ sở nhiều tiêu chí: giảng viên, đại học, các khoản tín dụng, thời gian, ngày, vv

cách tốt nhất để cung cấp một API trong tình huống này là gì?

Lựa chọn 1

Cung cấp nhiều URL như

example.com/api/byinstructor/<instructorcode> 
example.come/api/bycollege/<collegecode> 
example.com/api/bycollegeandinstructor/<collegecode>/<instructorcode> 
...and so on 

tôi sẽ cần phải có một URL cho tất cả các hoán vị. Điều này có vẻ rất cồng kềnh, cả cho tôi và người tiêu dùng API, và rất không có DRY.

Lựa chọn 2

Chỉ cung cấp các API cho các tùy chọn lớn như:

example.com/api/byinstructor/<instructorcode> 
example.come/api/bycollege/<collegecode> 

Và nếu người tiêu dùng muốn bycollegeandinstructor, anh ấy làm việc lọc trên cuối cùng của mình.

Lựa chọn 3

Người dùng vượt qua một chuỗi JSON với tôi, và tôi sử dụng để có được những tiêu chí lọc

example.com/api/getcourses/<jsonstring> 

jsonstring = 
{ 
    instructor:<instructorcode>, 
    college:<collegecode>, 
    ...and so on 
} 

Tôi cho rằng thay vì chuỗi Json, tôi cũng có thể yêu cầu một POST mảng, nhưng điều đó có vẻ không trực quan cho người tiêu dùng kể từ khi anh ta đang nhận dữ liệu.

Hoặc có cách nào khác để làm điều này mà tôi không biết? Nếu đó là tùy chọn thứ ba là tùy chọn tốt nhất, bạn có thể cung cấp tóm tắt ngắn nhất để chuẩn bị truy vấn SQL trên cơ sở chuỗi JSOn có thể có số lượng giá trị biến không?

Answer 1

Mở rộng trên câu trả lời từ JF, có vẻ như bạn có một nguồn lực, tập các khóa học, trong đó sẽ có mặt tại URI:

/courses 

Lọc tài nguyên thường được thực hiện sử dụng truy vấn các tham số để lọc tài nguyên đơn lẻ đó, ví dụ:

/courses?college=123&instructor=321 

Bằng cách này, bạn tránh vấn đề với tất cả các hoán vị có thể tạo ra sự gia tăng tài nguyên.

Về cơ bản: Có một tài nguyên, có thể được lọc khi cần thiết.

Answer 2

GET example.com/courses?college=<collegecode>&instructor=<instructorcode>