template-monorepo/generate/api/common.api

30 lines
1.0 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

syntax = "v1"
// 文件與實際 HTTP 回應共用結構handler 透過 response.Write 輸出)
// HTTP 狀態碼對照 errs.Error.HTTPStatus()internal/library/errors/errors.go
// 業務碼格式 SSCCCDDDscope * 1_000_000 + category * 1_000 + detail
// Facade scope=10handler parse/validate10101000 = InputInvalidFormat
// Auth scope=28、Member scope=29、Notification scope=30各模組 logic/usecase 使用對應 scope
type (
// ErrorDetail 失敗時 error 欄位
ErrorDetail {
BizCode string `json:"biz_code"`
Scope uint32 `json:"scope,omitempty"`
Category uint32 `json:"category,omitempty"`
Detail uint32 `json:"detail,omitempty"`
}
// APIErrorStatus 失敗回應 envelopeHTTP 4xx/5xx
APIErrorStatus {
Code int64 `json:"code"`
Message string `json:"message"`
Error ErrorDetail `json:"error"`
}
// EmptyOKStatus 成功但無 dataconfirm / delete 等code=102000
EmptyOKStatus {
Code int64 `json:"code"`
Message string `json:"message"`
}
)