REST API 標准 GET 請求返回部分響應

Question

我想為 api 設計一個端點，其中客戶端只會在響應有效負載中獲取 id。 例如部門/{departmentId}/users/ids，此端點將返回屬於此 deparmentId 的所有員工的 userIds 請讓我知道上述端點是否根據 rest api 標准真的有意義，或者應該有其他方式

Answer 1

請讓我知道根據 rest api 標准，上述端點是否真的有意義

是的，它很完美。 “任何可以命名的信息都可以是一種資源”（ 菲爾丁，2000 年）。

GET /departments/17/users/ids

200 OK
Content-Type: text/plain

1
2
3
4
5
...

沒關系。 如果您想使用其他表示形式（HTML 或JSON或其他），也可以。

從通用組件的角度來看，它只是一個文檔。 通過網絡傳輸文檔是 HTTP 的用途。

Answer 2

您可以刪除 /ids 后綴並使用部門/{departmentId}/users 並使用此路由進行分頁。 如果您正在對用戶進行分頁，並且您希望用戶很多，通常像這樣的 API 會返回列表頁面中使用的數據，這確實有意義，因此例如您可以返回用戶名、email、頭像鏈接和所需的所有信息到視圖。

沒有其他解決方案，除非您切換到 graphql 之類的東西。