Documentation ¶
Index ¶
- Constants
- func Failed(c *gin.Context, code StatusCode, description, messageID string)
- func Fatal(c *gin.Context, code StatusCode, err error, messageID string)
- func Success(c *gin.Context, messageID string, data *ResponseData)
- type RequestGET
- type RequestPOST
- type RequestPOSTCreate
- type Response
- type ResponseData
- type StatusCode
Constants ¶
View Source
const ( StatusCodeOk = StatusCode(100000 + iota) StatusCodeValidationError StatusCodeNotFound StatusCodeAuthFailed StatusCodeCreateServiceError = StatusCode(200000) StatusCodeMySQLError = StatusCode(300000) StatusCodeRedisError = StatusCode(400000) )
View Source
const ( RouteCron = "cron" RouteCreate = "create" )
View Source
const (
APIPath = "/api/"
)
Variables ¶
This section is empty.
Functions ¶
func Failed ¶
func Failed(c *gin.Context, code StatusCode, description, messageID string)
Failed Client请求失败(通过panic终止代码)
Types ¶
type RequestGET ¶
type RequestGET struct { Key string `json:"key" binding:"required" form:"key"` Value string `json:"value,omitempty" form:"value"` }
RequestGET GET请求(URLQuery)
type RequestPOST ¶
type RequestPOST struct { Key string `json:"key" binding:"required"` Value []byte `json:"value,omitempty"` }
RequestPOST POST请求(Body)
type RequestPOSTCreate ¶
type RequestPOSTCreate struct { ServiceName string `json:"service_name" binding:"required" validate:"lowercase"` ModName string `json:"mod_name" binding:"required" validate:"lowercase"` InstallDir string `json:"install_dir,omitempty" validate:"omitempty,lowercase"` }
RequestPOSTCreate POST-Create请求(Body)
type Response ¶
type Response struct { Code StatusCode `json:"code"` Description string `json:"description"` MessageID string `json:"message_id"` Data *ResponseData `json:"data,omitempty"` }
Response HTTP统一回复结构
type ResponseData ¶
type ResponseData struct {
Payload []byte `json:"payload,omitempty"`
}
ResponseData 具体回复的内容
type StatusCode ¶
type StatusCode uint
Click to show internal directories.
Click to hide internal directories.