schema

Documentation

Index

• type HTTPError
• type HTTPErrorItem
• type HTTPList
• type HTTPPagination
• type HTTPStatus
• type HTTPStatusText
  • func (t HTTPStatusText) String() string
• type PaginationParam
• type PaginationResult

Types

type HTTPError

type HTTPError struct {
	Error HTTPErrorItem `json:"error"` // Error item
}

HTTPError - HTTP response error

type HTTPErrorItem

type HTTPErrorItem struct {
	Code    int    `json:"code"`    // Error code
	Message string `json:"message"` // Error message
}

HTTPErrorItem HTTP response error item

type HTTPList

type HTTPList struct {
	List       interface{}     `json:"list"`
	Pagination *HTTPPagination `json:"pagination,omitempty"`
}

HTTPList - HTTP response list data

type HTTPPagination

type HTTPPagination struct {
	Total    int `json:"total"`
	Current  int `json:"current"`
	PageSize int `json:"pageSize"`
}

HTTPPagination - HTTP paging data

type HTTPStatus

type HTTPStatus struct {
	Status string `json:"status"` // status(OK)
}

HTTPStatus - HTTP response status

type HTTPStatusText

type HTTPStatusText string

HTTPStatusText - Define HTTP status text

const (
	OKStatusText HTTPStatusText = "OK"
)

Define HTTP status text constants

func (HTTPStatusText) String

func (t HTTPStatusText) String() string

type PaginationParam

type PaginationParam struct {
	PageIndex int // Page index
	PageSize  int // Page size
}

PaginationParam - Paging query condition

type PaginationResult

type PaginationResult struct {
	Total int // Total number of data
}

PaginationResult - Paging query results