API使用說明

基本結構

請求的 URL 格式如下：

https://hkspd.siuyeong.com/api

https://hkspd.siuyeong.com/api?page=<page>&limit=<limit>&order=<order>

https://hkspd.siuyeong.com/api?caseID=<caseID>

參數說明

?page=<page>

功能：指定要獲取的頁碼。當沒有指定 caseID 時有效。

預設值：如果未提供，則默認為 1。

範例：?page=2 將返回第二頁的數據。

?limit=<limit>

功能：指定每頁返回的記錄數。當沒有指定 caseID 時有效。

預設值：如果未提供，則不進行分頁，返回所有記錄。

範例：?limit=10 將每頁限制為 10 條記錄。

?caseID=<caseID>

功能：根據指定的 caseID 過濾返回的記錄。如果提供了 caseID，只會返回唯一一項記錄，則 page、limit 和 order 參數無效。

範例：?caseID=2025011002 將僅返回 caseID 為 2025011002 的記錄。

?order=<order>

功能：指定返回記錄的排序方式。當沒有指定 caseID 時有效。

可選值：

asc：按 caseID 升序排序。

desc：按 caseID 降序排序。

範例：?order=asc 將返回按 caseID 升序排列的記錄。

使用示例

獲取第一頁的所有記錄：

https://hkspd.siuyeong.com/api

獲取第二頁的 10 條記錄：

https://hkspd.siuyeong.com/api?page=2&limit=10

獲取特定 caseID 的記錄（唯一一項）：

https://hkspd.siuyeong.com/api?caseID=2025011002

獲取特定 caseID 的記錄並指定排序（無效，因為只返回唯一一項）：

https://hkspd.siuyeong.com/api?caseID=2025011002&order=asc

獲取特定 caseID 的第一頁 5 條記錄，並按降序排序（無效，因為只返回唯一一項）：

https://hkspd.siuyeong.com/api?caseID=2025011002&page=1&limit=5&order=desc

注意事項

當使用 ?limit= 和 ?order= 參數時，必須在未提供 caseID 的情況下使用，否則這些參數將無效。

若未提供 caseID，將返回所有記錄。

若未提供 order，則將按原始順序返回數據（僅適用於未指定 caseID 的情況）。