ginserver

type DefaultServer struct{}

type ListData struct {
	// multiple data
	Items interface{} `json:"items,omitempty"`
	// total count
	Total int `json:"total"`
}

type MiddlewaresObject struct {
	Methods     []string
	Middlewares []gin.HandlerFunc
}

type Request struct {
	ID    uint64 `param:"id"`
	Page  int    `form:"page"`
	Limit int    `form:"limit"`
	// sort field, default is create time
	Sort string `form:"sort"`
	// sort order
	Order string `form:"order"`
}

type Response struct {
	State State `json:"state"`
	// multiple data is a list, single data is a object
	Data interface{} `json:"data,omitempty"`
}

type RestController interface {
	// Create is the method for router.POST
	Create() (gin.HandlerFunc, error)
	// Delete is the method for router.DELETE
	Delete() (gin.HandlerFunc, error)
	// Update is the method for router.PUT
	Update() (gin.HandlerFunc, error)
	// Patch is the method for router.PATCH
	Patch() (gin.HandlerFunc, error)
	// Get is the method for router.GET
	Get() (gin.HandlerFunc, error)
	// List is the method for router.GET with query parameters
	List() (gin.HandlerFunc, error)
	// current api verison
	Version() string
	// curent api path
	Name() string
	// middlewares for current api group
	Middlewares() []MiddlewaresObject
}

type RestfulAPI struct {

	// prefix for current resource
	PreParameter string
	// postfix for current resource
	PostParameter string
	// contains filtered or unexported fields
}

type State struct {
	// 0 success, other error
	Code int `json:"code"`
	// success or error message
	Msg string `json:"msg"`
}