交付流程 · 產物閱讀
JSONexamples/quality-workflow/api-contract.json

API 契約

欄位已分組,原始字段名保留在標籤旁。展開詳細資料或切換原始檔,可核對完整內容。

資料性質kind
teaching-contract-not-openapi
版本version
demo-api-1
endpointendpoint
POST /payments
requestrequest
order_idorder_id
non-empty string
responsesresponses
200200
order_idorder_id
requested order
狀態status
PAID
400400
errorerror
INVALID_REQUEST
404404
errorerror
ORDER_NOT_FOUND
409409
errorerror
ORDER_ALREADY_PAID
persistencepersistence
ordersorders
id TEXT PRIMARY KEY, status TEXT NOT NULL (PENDING or PAID)
paymentspayments
id INTEGER PRIMARY KEY, order_id TEXT NOT NULL
successful_paymentsuccessful_payment
one payment row and PENDING -> PAID in one atomic transaction
rejected_paymentrejected_payment
no state or row count changes
concurrencyconcurrency
two simultaneous requests for one PENDING order yield one 200, one 409 and one payment
not_in_scopenot_in_scope
  • real payment provider
  • authentication
  • pricing
  • refunds
  • multi-tenant isolation

靜態唯讀副本 · 可直接開啟,不需伺服器;不改變核准或執行結果