Smile PythonEnglish
← 所有技術作品

01 / REST API

技術示範・模擬資料

商店庫存與訂單 API

用 Python 建立可供其他系統讀取的商品、庫存及訂單查詢介面。按編號查詢、檢查輸入,並提供 OpenAPI 介面說明;不寫入資料。

一筆商品查詢的完整回應站內試用台 · 模擬資料

01 / 請求

GET /api/lab/products/P-1001

在網址指定商品編號。這是本站唯讀示範端點,和下方 GitHub 專案的路徑不同。

02 / 回應 200 OK

{
  "data": {
    "id": "P-1001",
    "label": "晨光手帳",
    "category": "文具",
    "price": {"amount": 420, "currency": "TWD"},
    "available": true
  },
  "meta": {"synthetic": true}
}

商品資料在 data;meta.synthetic 標記資料為模擬資料。

到試用台送出同一筆請求 ↗也可比較不存在的 P-9999(404)或格式錯誤的 P001(400)。

試看請求與介面文件

原始碼庫提供 OpenAPI 契約。以下是兩個讀取路徑,需在自行啟動的測試環境中帶入該環境的 Bearer 權杖:

GET /api/products/P001/inventory
GET /api/orders/O004/status
Authorization: Bearer <YOUR_TEST_TOKEN>

商品庫存回傳商品編號、名稱、庫存數量與是否供應。訂單狀態回傳訂單編號、狀態與更新時間。

如何驗收這類介面

  • 使用已存在的 ID,確認回應符合文件列出的欄位。
  • 在本站試用台輸入不存在的 ID,檢查 404;輸入不合法的格式,檢查 400。
  • 資料及訂單都供示範,並非真實商家或客戶資料。

站內試用台可向本站的唯讀 API 發出請求,並查看狀態碼及 JSON 回應;只使用模擬資料。