CatQuest 資料 API 參考
CatQuest 介面讀取 giip 問題列表 API(giipIssues),並將每個問題繪製為貓咪卡片。本文件說明如何 透過 API 直接查詢 該資料來源,以及介面的狀態→貓咪對應。
- 主機:
https://giipfaw.azurewebsites.net - 認證: 請求標頭
x-api-key攜帶登入使用者的 AK(或專案範圍的 SK)。查詢範圍限定為該金鑰的csn(專案)。 - 結果代碼(RstVal) 約定請參閱 API 結果代碼。
查詢問題列表 — giipIssues GET
這是 CatQuest 在頁面載入時呼叫的讀取 API。
curl "https://giipfaw.azurewebsites.net/api/giipIssues?csn=47" \
-H "x-api-key: <YOUR_AK>"
請求參數
| 名稱 | 位置 | 必填 | 說明 |
|---|---|---|---|
csn | query | ✅ | 要查詢的專案編號。CatQuest 會自動填入目前所選專案的 csn。 |
回應範例
{
"issues": [
{
"isn": 735,
"title": "建立 admin/catquest 使用者指南",
"status": "READY",
"regdate": "2026-07-24T08:54:00Z",
"summary": "啟用指南按鈕",
"last_comment_date": "2026-07-24T09:00:00Z",
"blocked_by_isn": null,
"blocked_by_title": null
}
]
}
回應欄位(CatQuest 使用的欄位)
| 欄位 | 型別 | 介面用途 |
|---|---|---|
isn | number | 問題編號(#isn 徽章)。分配哪隻貓咪也由 isn 決定。 |
title | string | 卡片頂部氣泡標題 |
status | string | 決定貓咪行為(動畫)— 參見下方對應 |
regdate | string | 註冊時間(🐣) |
summary | string | 卡片底部摘要(存在時) |
last_comment_date | string | null | 最後留言時間(💬),為空時顯示「無留言」 |
blocked_by_isn | number | null | 等待(blocked-by)徽章 — 阻塞此問題的佔用問題編號 |
blocked_by_title | string | null | 等待徽章的提示(佔用問題標題) |
狀態 → 貓咪行為 對應
CatQuest 前端依以下規則將 status 值對應到動畫(這是顯示規則,而非伺服器值)。
| status | 貓咪狀態 | 圖片檔案模式 |
|---|---|---|
| PENDING | playing | /images/catquest/<cat>_playing.png |
| READY | ready | /images/catquest/<cat>_ready.png |
| IN_PROGRESS | hunting | /images/catquest/<cat>_hunting.png |
| REVIEW | delivering | /images/catquest/<cat>_delivering.png |
| DONE | playing | /images/catquest/<cat>_playing.png |
<cat>透過isn % 8從 8 種(mochi、sherlock、nimbus、pixel、cocoa、midnight、luna、leo)中確定性地分配一種。
相關 API
- 建立 / 更新 / 變更問題狀態: 若要以程式化方式建立或流轉問題,請參閱 問題與任務 API。
- 查詢 / 新增留言: 問題詳情介面使用
giipIssueCommentsAPI。
疑難排解
| 現象 | 原因 | 解決 |
|---|---|---|
401 Unauthorized | 缺少或過期的 x-api-key | 使用有效的 AK 重新呼叫,或重新登入。 |
空的 issues: [] | 該 csn 沒有問題 | 檢查 csn 值或註冊一個問題。 |
未帶 csn 呼叫 | 缺少必填參數 | 務必包含 ?csn=<編號>。 |
版本: 1.0
最後更新: 2026-07-24
原始檔案: giipv3/public/help/api-catquest.zh-TW.md